| t |
| t |
| Setting | Value |
|---|---|
| ",s[h]," | "),c.push(""),o(c,h,l[h],i.getOption(h)),c.push(" |
| Setting | Value |
|---|---|
| ",s[h]," | "),c.push(""),o(c,h,l[h],i.getOption(h)),c.push(" |
AsciiDoc headers can be written in two ways: with differing underlines or with different indentation using = (equals sign). AsciiDoc supports headings 1-4. The editor will automatically use the = notation. To create a level one header, prefix your line with one =. Level two headers are created with == and so on.
To display text as bold, wrap the text in * (asterisks). To display text as italic, wrap the text in _ (underscores). To create monospace text, wrap the text in ` (backtick)."},{menuName:"Scripts",data:"
Superscript and subscript is created the same way as other inline formats. To create superscript text, wrap your text in ^ (carats). To create subscript text, wrap your text in ~ (tildes).
AsciiDoc will automatically convert textual representations of commonly-used special characters. For example, (R) becomes ®, (C) becomes © and (TM) becomes ™.
AsciiDoc allows paragraphs to have optional titles or icons to denote special sections. To make a normal paragraph, simply add a line between blocks and a new paragraph will start. If you want to title your paragraphs, adda line prefixed by . (full stop). An example paragraph with optional title is displayed below:.Optional Title
This is my paragraph. It is two sentences long.
To create source blocks (long blocks of code), follow the same syntax as above but with an extra line denoting the inline source and lines of four dashes (----) delimiting the source block.. An example of Python source is below:.python.py
[source,python]
----
# i just wrote a comment in python
# and maybe one more
----
Comment blocks are useful if you want to keep notes for yourself inline but do not want them displayed to the public. To create a comment block, simply wrap the paragraph in dividers with four slashes (////). An example comment block is below:////
My comment block is here now
It can be multiple paragraphs. Really.
////
Quote blocks work much like comment blocks — simply create dividers using four underscores (____) around your quote. An example quote block is displayed below:____
This is my quote block. Quote something nice here, otherwise there is no point in quoting.
____
To create links to external pages, you can simply write the URI if you want the URI to link to itself. (i.e., http://github.com/ will automatically be parsed to http://github.com/. If you want different text to be displayed, simply append it to the end of the URI in between [ (brackets.) For example, http://github.com/[GitHub] will be parsed as GitHub, with the URI pointing to http://github.com.
Images in AsciiDoc work much like hyperlinks, but image URLs are prefixed with image:. For example, to link to an image at images/icons/home.png, write image:images/icons/home.png. Alt text can be added by appending the text to the URI in [ (brackets).
To create a paragraph, simply create a block of text that is not separated by one or more blank lines. Blocks of text separated by one or more blank lines will be parsed as paragraphs.
If you want to create a line break, end a line with two or more spaces, then hit Return/Enter.
"},{menuName:"Headers",data:"Markdown supports two header formats. The wiki editor uses the “atx’-style headers. Simply prefix your header text with the number of # characters to specify heading depth. For example: # Header 1, ## Header 2 and ### Header 3 will be progressively smaller headers. You may end your headers with any number of hashes.
Markdown creates blockquotes email-style by prefixing each line with the >. This looks best if you decide to hard-wrap text and prefix each line with a > character, but Markdown supports just putting > before your paragraph.
Markdown supports both ordered and unordered lists. To create an ordered list, simply prefix each line with a number (any number will do — this is why the editor only uses one number.) To create an unordered list, you can prefix each line with *, + or -.
Markdown wraps code blocks in pre-formatted tags to preserve indentation in your code blocks. To create a code block, indent the entire block by at least 4 spaces or one tab. Markdown will strip the extra indentation you’ve added to the code block.
"},{menuName:"Horizontal Rules",data:"Horizontal rules are created by placing three or more hyphens, asterisks or underscores on a line by themselves. Spaces are allowed between the hyphens, asterisks or underscores."}]},{menuName:"Span Elements",content:[{menuName:"Links",data:"Markdown has two types of links: inline and reference. For both types of links, the text you want to display to the user is placed in square brackets. For example, if you want your link to display the text “GitHub”, you write [GitHub].
To create an inline link, create a set of parentheses immediately after the brackets and write your URL within the parentheses. (e.g., [GitHub](http://github.com/)). Relative paths are allowed in inline links.
To create a reference link, use two sets of square brackets. [my internal link][internal-ref] will link to the internal reference internal-ref.
Asterisks (*) and underscores (_) are treated as emphasis and are wrapped with an <em> tag, which usually displays as italics in most browsers. Double asterisks (**) or double underscores (__) are treated as bold using the <strong> tag. To create italic or bold text, simply wrap your words in single/double asterisks/underscores. For example, **My double emphasis text** becomes My double emphasis text, and *My single emphasis text* becomes My single emphasis text.
To create inline spans of code, simply wrap the code in backticks (`). Markdown will turn `myFunction` into myFunction.
Markdown image syntax looks a lot like the syntax for links; it is essentially the same syntax preceded by an exclamation point (!). For example, if you want to link to an image at http://github.com/unicorn.png with the alternate text My Unicorn, you would write .
If you want to create a link that displays the actual URL, markdown allows you to quickly wrap the URL in < and > to do so. For example, the link http://github.com/ is easily produced by writing <http://github.com/>.
If you want to use a special Markdown character in your document (such as displaying literal asterisks), you can escape the character with the backslash (\\). Markdown will ignore the character directly after a backslash."},{menuName:"Emoji",data:'
See the EmojiOne demo for all available emoji. To include one, wrap the emoji name in colons and use underscores instead of spaces (e.g. :heart: or :point_up:).'}]}];e.GollumEditor.defineHelp("markdown",n)}(jQuery),function(e){var t={"function-bold":{replace:"'''$1'''$2"},"function-italic":{replace:"''$1''$2"},"function-hr":{append:"\n---\n"},"function-code":{replace:"$1$2"},"function-ol":{link:function(e,t){return"# "+t+"\n"}},"function-blockquote":{replace:"
\n$1$2\n"},"function-h1":{replace:"= $1$2 ="},"function-h2":{replace:"== $1$2 =="},"function-h3":{replace:"=== $1$2 ==="},"function-link":{replace:function(e){var t="";return e.text&&e.href&&(t="["+e.href+" | "+e.text+"]"),t}}};e.GollumEditor.defineLanguage("mediawiki",e.constructLanguageDefinition(t));var n=[{menuName:"Text Formatting",content:[{menuName:"Headers",data:"
MediaWiki headers are written with different indentation using = Title = (equals sign). MediaWiki supports headings 1-6.
To display text as bold, wrap the text in '''. To display text as italic, wrap the text in ''. To create monospace text, wrap the text in <code></code>."},{menuName:"Special Characters",data:"
Use HTML special characters, e.g. © or €
MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tag
Tables may be authored in wiki pages using either XHTML table elements directly, or using wikicode formatting to define the table. Wikitable syntax overview:
| table start |
| table caption, optional; only between table start and first table row |
| table row, optional on first row -- wiki engine assumes the first row |
| table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (!!) or start on new lines, each with its own single mark (!). |
| table data cell, required! Consecutive table data cells may be added on same line separated by double marks (||) or start on new lines, each with its own single mark (|). |
| table end |
To create links to external pages, use single brackets, e.g. [https://mediawiki.org MediaWiki]. Internal links use double brackets: [[Main Page]]. To define the link text, use [[Main Page | this is displayed]] (note: the order of the URL/Page Name and the link text is reversed compared to Gollum pages in other markups).
Use Gollum internal links, e.g. To create a paragraph, simply create a block of text that is not separated by one or more blank lines. Blocks of text separated by one or more blank lines will be parsed as paragraphs. Simply prefix your header text with the number of To create a blockquote, simple embed the text between Org-mode supports both ordered and unordered lists. To create an ordered list, simply prefix each line with a number (any number will do — this is why the editor only uses one number.) To create an unordered list, you can prefix each line with Code Blocks are similar to blockquote, except that Org-mode supports simple tables (tables with equal number of cells in each row). To create a simple table, just separate the contents of each cell with a To create links to external pages, you need to enclose the URI in double square brackets. (i.e., Forward slashes ( To create inline spans of code, simply wrap the code in equal signs ( Org-mode image syntax is exactly same as the syntax that you would use for a URI to link to itself. The image URI is enclosed in double square brackets. Alt text on images is not currently supported by Gollum's Org-mode parser. All command paragraphs start with To create headings 1 through 4, begin your command paragraph with Perl pod blocks should begin with pod also allows blocks in other formats, such as HTML or plain text. To create one of these blocks, use the If you are having encoding troubles, use the Formatting text as bold, italic or Writing hyperlinks in pod is much like formatting text, using the same pod allows you to hyperlink to a To create a paragraph, simply create a block of text that is not separated by one or more blank lines. Blocks of text separated by one or more blank lines will be parsed as paragraphs. Rest uses overline/underline adornments to indicate headers. To create a header, underline your header text with adornment characters such as the Rest creates blockquotes using indentation. This looks best if you use four spaces per level of indentation. Rest supports both ordered and unordered lists. To create an ordered list, simply prefix each line with a number, or use Rest wraps code blocks in pre-formatted tags to preserve indentation in your code blocks. To create a code block, indent the entire block by at least 4 spaces or one tab. Rest will strip the extra indentation you’ve added to the code block. Horizontal rules are created by placing four or more hyphens, asterisks or underscores on a line by themselves. To create an inline link, create a set of backticks, include the link title first, followed by the url in angled brackets (e.g., Asterisks ( To create inline spans of code, simply wrap the code in backticks ( Rest image syntax is two dots, followed by a space, the word "image", two colons, another space, and the url: If you want to use a special Rest character in your document (such as displaying literal asterisks), you can escape the character with the backslash ( To place emphasis or strength on inline text, simply place To force italics or bold, simply double the characters: To display citations, wrap your text in To display edit marks such as deleted text (strikethrough) or inserted text (underlined text), wrap your text in To display superscript, wrap your text in To display monospace code, wrap your text in To create an acronym, suffix the acronym with the definition in parentheses. For example, To display a heading in Textile, prefix your line of text with To create a new paragraph, prefix your first line of a block of text with To create a blockquote, make sure at least one blank line exists between your text and any surrounding text, and then prefix that block with Code blocks in textile are simply prefixed like any other block. To create a code block, place the beginning of the block on a separate line and prefix it with To display a preformatted block, prefix the block with To create ordered lists, prefix each line with To display a link, put the text you want to display in quotes, then a colon ( To display an image, simply wrap the image’s URL in [[sauron.jpg]], to insert images."}]}];e.GollumEditor.defineHelp("mediawiki",n)}(jQuery),function(e){var t={"function-bold":{replace:"*$1*$2"},"function-italic":{replace:"/$1/$2"},"function-code":{replace:"=$1=$2"},"function-hr":undefined,"function-blockquote":{replace:"#+BEGIN_QUOTE\n$1$2\n#+END_QUOTE"},"function-h1":{replace:"* $1$2"},"function-h2":{replace:"** $1$2"},"function-h3":{replace:"*** $1$2"},"function-link":{replace:function(e){var t="";return e.text&&e.href?t="[["+e.href+"]["+e.text+"]]":e.href&&(t="[["+e.href+"]]"),t}},"function-image":{replace:function(e){var t="";return e.url&&(t="[["+e.url+"]]"),t}}};e.GollumEditor.defineLanguage("org",e.constructLanguageDefinition(t));var n=[{menuName:"Block Elements",content:[{menuName:"Paragraphs & Breaks",data:"* characters to specify heading depth. For example: * Header 1, ** Header 2 and *** Header 3 will be progressively smaller headers.#+BEGIN_QUOTE and #+END_QUOTE. An example quote block is displayed below:#+BEGIN_QUOTE
This is my quote block. Quote something nice here, otherwise there is no point in quoting.
#+END_QUOTE+ or -.#+BEGIN_EXAMPLE and #+END_EXAMPLE are used.| character. For example, |one|two|three|
|four|five|six|
will appear as a table with two rows and three columns. Additionally, |one|two|three|
|---+---+-----|
|four|five|six|
will also appear as a table, but the first row will be interpreted as a header row and the <th> tag will be used to render it. [[http://github.com/]] will automatically be parsed to http://github.com/)If you want to add text, to be displayed to the user, you write the URI and the text next to each other, both enclosed in square brackets and both of them together enclosed in another pair of square brackets. For example, if you want your link to display the text “GitHub”, you write [[http://github.com][GitHub]]./) are treated as emphasis and are wrapped with an <i> tag. Asterisks (*) are treated as bold using the <b> tag.=). Orgmode will turn =myFunction= into myFunction.= (equals sign).=headN, where N is the number of the heading 1 through 4. For example, to make a first-order heading (the largest possible,) write =head1, then on the next line begin your paragraph that you want under the heading.=pod and end with =cut, signifying to Pod parsers that the pod block has begun and ended. These command paragraphs only signal the beginning and end of a pod block.=format SYNTAX command paragraph, where SYNTAX is the syntax of the block (e.g. html or txt). At the end of your block, use the =end SYNTAX block.=encoding ENC_TYPE command, where ENC_TYPE is the encoding type (e.g. utf8, koi8-r). This will affect the entire document, not just the block below the command.code works in the S<word> syntax, where S is an abbreviation for the type of text you are trying to create. For example, B<my bold text> becomes my bold text, I<italic text> becomes italic text and C<code here()> becomes code here().S<> syntax. Instead of B, I or C, use L to begin a hyperlink.man page, a Perl documentation page, or another web page. To link to a man or Perl documentation page, simply include the page name in the link (e.g. L<perl(1)> or L<Net::Ping>). If you want to link to a web page, separate the URL and the link text with a pipe (e.g. to link to github.com, write L<GitHub|http://github.com/>)."}]}];e.GollumEditor.defineHelp("pod",n)}(jQuery),function(e){var t={"function-code":undefined,"function-h1":undefined,"function-h2":undefined,"function-h3":undefined,"function-link":undefined,"function-image":undefined,"function-hr":undefined,"function-blockquote":undefined};e.GollumEditor.defineLanguage("rdoc",e.constructLanguageDefinition(t))}(jQuery),function(e){var t=function(t,n,i){var o="";o=t.length?t:"Title here",adornment=i.repeat(o.length),o=o+"\n"+adornment+"\n",e.GollumEditor.replaceSelection(o,!1,!1,n)},n={"function-bold":{replace:"**$1**$2"},"function-italic":{replace:"*$1*$2"},"function-code":{replace:"``$1``$2"},"function-hr":{append:"\n\n----\n\n"},"function-blockquote":{exec:function(t,n){for(var i=" ",o=n.split("\n"),r=0;r=, ~, +, ^ characters. Make sure that the adornment is of the same length (or longer) as the header text. Use a different adornment character to specify a different heading depth.# for auto enumeration. To create an unordered list, you can prefix each line with *, + or -.`Python ).*) are treated as emphasis and are wrapped with an <em> tag, which usually displays as italics in most browsers. Double asterisks (**) are treated as bold using the <strong> tag. To create italic or bold text, simply wrap your words in single/double asterisks. For example, **My double emphasis text** becomes My double emphasis text, and *My single emphasis text* becomes My single emphasis text.`). Rest will turn `myFunction` into myFunction... image:: http://image.com/image.png.\\). Rest will ignore the character directly after a backslash."}]}];e.GollumEditor.defineHelp("rst",i)}(jQuery),function(e){var t={"function-hr":undefined,
"function-code":{replace:"bc. $1$2",whole_line:!0},"function-ol":{line:function(e,t){return"# "+t+"\n"}},"function-blockquote":{replace:"bq. $1$2"},"function-h1":{replace:"h1. $1$2"},"function-h2":{replace:"h2. $1$2"},"function-h3":{replace:"h3. $1$2"},"function-link":{replace:function(e){var t="";return e.text&&e.href&&(t='"'+e.text+'":'+e.href),t}},"function-image":{replace:function(e){var t="";if(e.url){var t="!"+e.url;return""!=e.alt&&(t+="("+e.alt+")"),t+="!"}}}};e.GollumEditor.defineLanguage("textile",e.constructLanguageDefinition(t));var n=[{menuName:"Phrase Modifiers",content:[{menuName:"Emphasis / Strength",data:"_ (underscores) around the text for emphasis or * (asterisks) around the text for strength. In most browsers, _mytext_ will appear as italics and *mytext* will appear as bold.__mytext__ will appear italic and **mytext** will appear as bold text.?? (two question marks).- (minuses) or + (pluses). For example -mytext- will be rendered as mytext and +mytext+ will be rendered as mytext^ (carets). To display subscript, wrap your text in ~ (tildes).@ (at symbol). For example, @mytext@ will appear as mytext.JS(JavaScript) will be displayed as JS.hn., where n equals the heading size you want (1 is largest, 6 is smallest).p..bq. If you need to extend a blockquote to more than one text block, write bq.. (note the two periods) and prefix your next normal paragraph with p.bc.pre.#. To create unordered lists, prefix each line with *.:), then the URL after the colon. For example "GitHub":http://github.com/ will appear as GitHub.! (exclamation points). If you want to link the image to a URL, you can blend the image and link syntax: place your image URL in the exclamation points and suffix that with a colon and your URL. For example, an image at http://myurl/image.png that should link to http://myurl/ should be written as !http://myurl/image.png!:http://myurl/.