UNPKG

grunt-init-assemble

Version:
125 lines (102 loc) 3.46 kB
## Code ### Inline code Wrap inline snippets of code with `` ` ``. For example, `<section></section>` should be wrapped as "inline". ``` html For example, `<section></section>` should be wrapped as "inline". ``` ### Indented code Or indent several lines of code by at least four spaces, as in: ``` js // Some comments line 1 of code line 2 of code line 3 of code ``` // Some comments line 1 of code line 2 of code line 3 of code ### Block code "fences" Use "fences" ```` ``` ```` to block in multiple lines of code. <pre> ``` html Sample text here... ``` </pre> ``` Sample text here... ``` HTML: ``` html <pre> <p>Sample text here...</p> </pre> ``` ### Syntax highlighting 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. For example, to apply syntax highlighting to JavaScript code: <pre> ``` javascript 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'] } } } }; ``` </pre> Renders to: ``` javascript 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'] } } } }; ``` And this complicated HTML: ``` xml <div class="highlight"><pre><span class="nx">grunt</span><span class="p">.</span><span class="nx">initConfig</span><span class="p">({</span> <span class="nx">assemble</span><span class="o">:</span> <span class="p">{</span> <span class="nx">options</span><span class="o">:</span> <span class="p">{</span> <span class="nx">assets</span><span class="o">:</span> <span class="s1">'docs/assets'</span><span class="p">,</span> <span class="nx">data</span><span class="o">:</span> <span class="s1">'src/data/*.{json,yml}'</span><span class="p">,</span> <span class="nx">helpers</span><span class="o">:</span> <span class="s1">'src/custom-helpers.js'</span><span class="p">,</span> <span class="nx">partials</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/partials/**/*.{hbs,md}'</span><span class="p">]</span> <span class="p">},</span> <span class="nx">pages</span><span class="o">:</span> <span class="p">{</span> <span class="nx">options</span><span class="o">:</span> <span class="p">{</span> <span class="nx">layout</span><span class="o">:</span> <span class="s1">'default.hbs'</span> <span class="p">},</span> <span class="nx">files</span><span class="o">:</span> <span class="p">{</span> <span class="s1">'./'</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/templates/pages/index.hbs'</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">};</span> </pre></div> ```