mnapoli/gh-pages-compiler

此包已被废弃，不再维护。未建议替代包。

GitHub Pages 的 Markdown 编译器

维护者

详细信息

github.com/mnapoli/gh-pages-compiler

主页

源代码

问题

安装: 9

依赖: 0

建议者: 0

安全性: 0

星星: 13

关注者: 1

分支: 4

开放问题: 2

语言:JavaScript

dev-master 2014-01-17 16:47 UTC

MIT 5b053c37c8fcde391450cfc46dd5b40a85d2fb32

  • Matthieu Napoli

markdowngithubpagescompilerwebsitegh-pages

This package is auto-updated.

Last update: 2020-01-19 10:47:31 UTC

README

gh-pages-compiler 从您的 Markdown 文档生成网站。

此包已不再维护。更近一步且更完整的版本在这里：Couscous。

简介

GitHub Pages 很好，但如果您想

  • 使用 Markdown 而不是 HTML 编写文档呢？
  • 如果希望将文档转换为 网站 呢？
  • 如果希望 将文档与代码一起保留，并使用存储库进行版本控制呢？

gh-pages-compiler 正在为您服务。 您的文档使用 Markdown 编写，与源代码一起在存储库中进行版本控制，编译为 HTML 并发布到 GitHub Pages。

它是如何工作的

  1. 您在存储库中用 .md 文件（Markdown）编写 README 和文档
  2. 使用 gh-pages-compiler 生成您的网站
  • 它将 .md 文件转换为 HTML 文件
  • HTML 文件被提交到存储库的 gh-pages 分支，并由 GitHub 发布为网站
  1. 盈利！

特性

  • 使用与 GitHub 相同的配置编译 Markdown（以确保正确的结果）
  • 完全控制网站布局：您编写自己的模板和菜单
  • 支持任意数量的页面、图片、链接、JavaScript（在模板中）……
  • 由 GitHub 在 "GitHub Pages" 上托管，您无需托管自己的网站
  • 您的 README 将是您的首页，您的代码存储库将始终与您的网站同步

阅读更多

贡献

在 GitHub 上关注此项目

由 Matthieu Napoli 创建，受 ralph 的启发

示例