codegrid-markdown

CodeGrid-specified markdown processor.

使い方

$3

``sh npm i codegrid-markdown`

`$3`

javascript
var CodeGridMarkdown = require('codegrid-markdown');
var CGMDRenderer = new CodeGridMarkdown({
  // options for marked
});

var str = fs.readFileSync(__dirname + '/cg.md', 'utf-8'); var htmlStr = CGMDRenderer.render(str);`

`$3`

sh
cgmd ./path/to/your.md
or

cgmd ./path/to/your.md -o ./path/to/your.html
can also

cgmd '# foo'


Browserifyから利用する場合、ブラウザ環境でも利用可能です。
記法
- cgmdとしての拡張記法
- mdの拡張記法
この2パターンの拡張があります。

cgmdパターンは、通常のMarkdownの中に混ぜて書くことができ、[foo]通常のMarkdownテキスト[/foo]の形式で記述します。

`$3`

`[note] #### 注釈タイトル

注釈本文 [/note]`

↓

`html


  注釈タイトル

  注釈本文

$3

`[column] #### コラムタイトル

コラム本文 [/column]`

↓

`html


  コラムタイトル

  コラム本文

$3

`[demo]

`DEMOタイトル`

[/demo]`

↓

`html


クリックで再生モードにしたい場合。

`[demo]

`DEMOタイトル`

[/demo]`

ソースコードへのリンクが欲しい場合。

`[demo]

`DEMOタイトル`


ソースコード

[/demo]`

`$3`

`[imgbox] #### 画像タイトル画像の説明

!画像alt [/imgbox]`

↓

`html


  画像title

  画像の説明

$3

`[tree] #### ファイルツリー - src/ - styles/ - base.css - components/ - a-lot-of-files/ [/tree]`

`html


  ファイルツリー

  
    
      
        src/

        
          
            
              styles/

              
                base.css

              

            

          

        

          
            
              components/

              
                
                  
                    a-lot-of-files/

                    
                      ...

$3

`[jade] ul li jadeが li そのまま書けます

p またの名をpugとも言う [/jade]`

↓

`html


  jadeが

  そのまま書けます

またの名をpugとも言う


これらの記法は、互いにネストすることはできません。
次に、mdパターン。
$3


`html#素敵なdiv
<div></div>
`

GFMのコードブロックで、Syntaxに続けて#コードのタイトルを指定すると、以下が出力されます。

`html


  
    素敵なdiv

  

  
    
      <div></div>

コードのタイトル指定がない場合、通常のMarkdownのコードブロックとして処理されます。

LICENSE

MIT

codegrid-markdown

CodeGrid-specified markdown processor.

使い方

$3

``sh npm i codegrid-markdown`

`$3`

javascript
var CodeGridMarkdown = require('codegrid-markdown');
var CGMDRenderer = new CodeGridMarkdown({
  // options for marked
});

var str = fs.readFileSync(__dirname + '/cg.md', 'utf-8'); var htmlStr = CGMDRenderer.render(str);`

`$3`

sh
cgmd ./path/to/your.md
or

cgmd ./path/to/your.md -o ./path/to/your.html
can also

cgmd '# foo'


Browserifyから利用する場合、ブラウザ環境でも利用可能です。
記法
- cgmdとしての拡張記法
- mdの拡張記法
この2パターンの拡張があります。

cgmdパターンは、通常のMarkdownの中に混ぜて書くことができ、[foo]通常のMarkdownテキスト[/foo]の形式で記述します。

`$3`

`[note] #### 注釈タイトル

注釈本文 [/note]`

↓

`html


  注釈タイトル

  注釈本文

$3

`[column] #### コラムタイトル

コラム本文 [/column]`

↓

`html


  コラムタイトル

  コラム本文

$3

`[demo]

`DEMOタイトル`

[/demo]`

↓

`html


クリックで再生モードにしたい場合。

`[demo]

`DEMOタイトル`

[/demo]`

ソースコードへのリンクが欲しい場合。

`[demo]

`DEMOタイトル`


ソースコード

[/demo]`

`$3`

`[imgbox] #### 画像タイトル画像の説明

!画像alt [/imgbox]`

↓

`html


  画像title

  画像の説明

$3

`[tree] #### ファイルツリー - src/ - styles/ - base.css - components/ - a-lot-of-files/ [/tree]`

`html


  ファイルツリー

  
    
      
        src/

        
          
            
              styles/

              
                base.css

              

            

          

        

          
            
              components/

              
                
                  
                    a-lot-of-files/

                    
                      ...

$3

`[jade] ul li jadeが li そのまま書けます

p またの名をpugとも言う [/jade]`

↓

`html


  jadeが

  そのまま書けます

またの名をpugとも言う


これらの記法は、互いにネストすることはできません。
次に、mdパターン。
$3


`html#素敵なdiv
<div></div>
`

GFMのコードブロックで、Syntaxに続けて#コードのタイトルを指定すると、以下が出力されます。

`html


  
    素敵なdiv

  

  
    
      <div></div>

コードのタイトル指定がない場合、通常のMarkdownのコードブロックとして処理されます。

LICENSE

MIT