Project: ShardingSphere (App Definition and Development / Database)
File: markdown.en.md

date: 2016-04-09T16:50:16+02:00 title: Markdown syntax weight: 15 {{% notice note %}} This page is a shameful copy of the great . Only difference is information about image customization (, ...) {{% /notice%}} Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages. Markdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it. Some of the key benefits are: Markdown is simple to learn, with minimal extra characters so it's also quicker to write content. Less chance of errors when writing in markdown. Produces valid XHTML output. Keeps the content and the visual display separate, so you cannot mess up the look of your site. Write in any text editor or Markdown application you like. Markdown is a joy to use! John Gruber, the author of Markdown, puts it like this: The overriding design goal for Markdowns formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like its been marked up with tags or formatting instructions. While Markdowns syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdowns syntax is the format of plain text email. -- John Gruber Grav ships with built-in support for and . You must enable Markdown Extra in your `system.yaml` configuration file Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like: {{% notice info %}} <i class="fas fa-bookmark"></i> Bookmark this page for easy future reference! {{% /notice %}} Headings from `h1` through `h6` are constructed with a `#` for each level: ```markdown ``` Renders to: <!-- markdownlint-disable MD025 --> <!-- markdownlint-enable MD025 --> HTML: ```html <h1>h1 Heading</h1> <h2>h2 Heading</h2> <h3>h3 Heading</h3> <h4>h4 Heading</h4> <h5>h5 Heading</h5> <h6>h6 Heading</h6> ``` Comments should be HTML compatible ```html <!-- This is a comment --> ``` Comment below should NOT be seen: <!-- This is a comment --> The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following: `_`: three consecutive underscores ``: three consecutive dashes ``: three consecutive asterisks renders to: _ Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML. So this body copy: ```markdown Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. ``` renders to this HTML: ```html <p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p> ``` For emphasizing a snippet of text with a heavier font-weight. The following snippet of text is rendered as bold

```markdown rendered as bold text ``` renders to: <!-- markdownlint-disable MD036 --> rendered as bold text <!-- markdownlint-enable MD036 --> and this HTML ```html <strong>rendered as bold text</strong> ``` For emphasizing a snippet of text with italics. The following snippet of text is rendered as italicized text. ```markdown rendered as italicized text ``` renders to: <!-- markdownlint-disable MD036 --> rendered as italicized text <!-- markdownlint-enable MD036 --> and this HTML: ```html <em>rendered as italicized text</em> ``` In GFM (GitHub flavored Markdown) you can do strikethroughs. ```markdown Strike through this text. ``` Which renders to: Strike through this text. HTML: ```html <del>Strike through this text.</del> ``` For quoting blocks of content from another source within your document. Add `>` before any text you want to quote. ```markdown Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. ``` Renders to: Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. and this HTML: ```html <blockquote> <p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p> </blockquote> ``` Blockquotes can also be nested: ```markdown Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. ``` Renders to: Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. {{% notice note %}} The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called {{% /notice %}} A list of items in which the order of the items does not explicitly

You may use any of the following symbols to denote bullets for each list item: ```markdown valid bullet valid bullet valid bullet ``` For example ```markdown Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem ``` Renders to: <!-- markdownlint-disable MD004 --> Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem <!-- markdownlint-enable MD004 --> And this HTML ```html <ul> <li>Lorem ipsum dolor sit amet</li> <li>Consectetur adipiscing elit</li> <li>Integer molestie lorem at massa</li> <li>Facilisis in pretium nisl aliquet</li> <li>Nulla volutpat aliquam velit <ul> <li>Phasellus iaculis neque</li> <li>Purus sodales ultricies</li> <li>Vestibulum laoreet porttitor sem</li> <li>Ac tristique libero volutpat at</li> </ul> </li> <li>Faucibus porta lacus fringilla vel</li> <li>Aenean sit amet erat nunc</li> <li>Eget porttitor lorem</li> </ul> ``` A list of items in which the order of items does explicitly matter. ```markdown Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem ``` Renders to: Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem And this HTML: ```html <ol> <li>Lorem ipsum dolor sit amet</li> <li>Consectetur adipiscing elit</li> <li>Integer molestie lorem at massa</li> <li>Facilisis in pretium nisl aliquet</li> <li>Nulla volutpat aliquam velit</li> <li>Faucibus porta lacus fringilla vel</li> <li>Aenean sit amet erat nunc</li> <li>Eget porttitor lorem</li> </ol> ``` TIP: If you just use `1.` for each number, Markdown will automatically number each item. For example: ```markdown Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem ``` Renders to: Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Wrap inline snippets of code with `` ` ``. ```markdown In this example, `<section></section>` should be wrapped as code. ``` Renders to: In this example, `<section></section>` should be wrapped as code. HTML: ```html <p>In this example, <code>&lt;section&gt;&lt;/section&gt;</code> should be wrapped as <strong>code</strong>.</p> ``` Or indent several lines of code by at least two spaces, as in: ```markdown // Some comments line 1 of code line 2 of code line 3 of code ``` Renders to: <!-- markdownlint-disable MD046 --> // Some comments line 1 of code line 2 of code line 3 of code <!-- markdownlint-enable MD046 --> HTML: ```html <pre> <code> // Some comments line 1 of code line 2 of code line 3 of code </code> </pre> ``` Use "fences" ```` ``` ```` to block in multiple lines of code. ```markdown Sample text here... ``` HTML: ```html <pre> <code>Sample text here...</code> </pre> ``` GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. See for additional documentation. For example, to apply syntax highlighting to JavaScript code: ```plaintext ```js grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials//*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` ``` Renders to: ```js grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials//*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './':

} } } }; ``` Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned. ```markdown | Option | Description | | | -- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | ``` Renders to: | Option | Description | | | -- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | And this HTML: ```html <table> <tr> <th>Option</th> <th>Description</th> </tr> <tr> <td>data</td> <td>path to data files to supply the data that will be passed into templates.</td> </tr> <tr> <td>engine</td> <td>engine to be used for processing templates. Handlebars is the default.</td> </tr> <tr> <td>ext</td> <td>extension to be used for dest files.</td> </tr> </table> ``` Adding a colon on the right side of the dashes below any heading will right align text for that column. ```markdown | Option | Description | | :| --:| | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | ``` | Option | Description | | :| --:| | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | ```markdown ``` Renders to (hover over the link, there is no tooltip): HTML: ```html <a href="http://assemble.io">Assemble</a> ``` ```markdown ``` Renders to (hover over the link, there should be a tooltip): HTML: ```html <a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a> ``` Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters: ```markdown * ``` will jump to these sections: ```markdown Content for chapter one. Content for chapter one. Content for chapter one. ``` NOTE that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works. Images have a similar syntax to links but include a preceding exclamation point. ```markdown ``` or ```markdown ``` Like links, Images also have a footnote style syntax ```markdown ! ``` ! With a reference later in the document defining the URL location: Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`). ```markdown ``` ```markdown ``` ```markdown ``` Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones. ```markdown ``` ```markdown ``` ```markdown ``` Add a HTTP `featherlight` parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining `featherlight` to `false`. ```markdown ```