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