magi deprecated

魔術師

OSS プロジェクト用の Web サイトを構築する最も簡単な方法。

インストール

糸グローバル add magi# または npm npm i -g magi

使用法

README.mdが与えられた場合:

 # サイト名> サイトの説明## セクションのタイトル> セクションの説明セクションの本文の内容、**悪くないようですね**。

ターミナルでmagiを実行し、ブラウザを開くと、次のように表示されます。

どのように機能するのでしょうか?

# h1はサイト名として使用され、その後のblockquoteサイトの説明として使用され、 h1とh2の間のその他すべての内容がバナーに配置されます。

以下は、developit/unfetch を例として使用した別の例です。

レシピ

GitHub コーナー リボンを追加する

html-matter を使用して、マークダウン ファイルの任意の場所 (たとえば、先頭) に設定できます。

 <!-- @magigithub: オーナー/リポジトリ-->

解析する必要があることがわかるように@magiで始まる必要があることに注意してください。残りの部分は、Jekyll で使用される単純な前置構文です。

外部スタイルとスクリプト

外部リソースを使用してstyleとscriptタグを挿入するには:

 <!-- @magistyles: - ./css/custom.cssscripts: - ./js/app.js - ./js/post.js-->

CLI

 # デフォルトは README.md # サーバーを実行してプレビューしますmagi [file]# build html filemagi build [file]# デフォルトはindex.htmlに出力します# ただし変更できますmagi build [file] --out docs/index.html

貢献する

1. フォークしてください！

2. 機能ブランチを作成します: git checkout -b my-new-feature

3. 変更をコミットします: git commit -am 'Add some feature'

4. ブランチにプッシュ: git push origin my-new-feature

5. プルリクエストを送信してください:D

著者

magi © egoist、MIT ライセンスに基づいてリリースされています。
寄稿者 (リスト) の協力を得て、egoist によって作成および保守されています。

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin