当前位置: 首页 > 工具软件 > Flatdoc > 使用案例 >

利用 Flatdoc 快速建立 Github Pages

施华奥
2023-12-01

早先自己的 Github Pages 是 Jekyll 配置的,更新起来麻烦,年龄大了,精力有限,不打算自己维护这些东西了,要是真写点啥也不这么折腾了,随便找个地方就发布了。但是页面不想荒废了,留一个可以随时更新点啥信息的页面还是必须的。找来找去,发现 Flatdoc 比较方便,内容可以用 Markdown 写,页面直接在浏览器端渲染,符合我的需求。

Flatdoc 在其项目主页上写的比较明确:

Flatdoc is the fastest way to create a site for your open source project.

Flatdoc is a small JavaScript file that fetches Markdown files and renders them as full pages. Essentially, it’s the easiest way to make open source documentation from Readme files.

既然如此,按照 Github 的文档,配置 Github Pages 之后,参照 Flatdoc 提供的模版,修改出一个 index.html 页面,再加上一个 README.md 文件,此时 Github Pages 就配置完毕了。

修改 Flatdoc 的模版页面时要注意,网页加载的 HTTP 资源,要全部改成 HTTPS 链接。因为 Github Pages 加密网页内如果有非加密的资源,浏览器是不会加载那些资源的。

 类似资料: