magi deprecated

賢士

為您的 OSS 專案建立網站的最簡單方法。

安裝

紗線全域添加magi＃或npm npm i -g magi

用法

鑑於README.md ：

 # 網站名稱> 網站描述## 部分標題> 部分描述部分正文內容，**看起來不錯吧**。

在終端機中執行magi ，打開瀏覽器，您將看到：

它是如何運作的？

# h1用作網站名稱，後面的blockquote將用作網站描述， h1和h2之間的所有其他內容將放在橫幅中。

這是另一個使用developit/unfetch 作為範例：

食譜

新增 GitHub 角落功能區

您可以使用 html-matter 將其設定在 Markdown 檔案中的任何位置，例如在其頂部：

 <!-- @magigithub: 所有者/repo-->

請注意，它應該以@magi開頭，以便我們知道需要解析它，其餘部分是 Jekyll 中使用的簡單的 front-matter 語法。

外部樣式和腳本

若要使用外部資源插入style和script標籤：

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

命令列介面

# 預設為 README.md# 執行伺服器預覽magi [file]# 建置 html 檔案magi 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