实现的大体的思路如下：

• Markdown：书写文档
• Pandoc：格式转化
• Sphinx：生成网页
• GitHub：托管项目
• ReadtheDocs：发布网页

接下来，就来看看到底是如何实现的？

进群：548377875     即可获取数十套PDF哦！

成品展示

---

 

以我的博客为例，先给大家展示一下。

这是首页。显示了你所有的文章索引。

这是我的导航栏。是不是结构很清晰，很方便索引。

点击文章后，还可以很方便查看标题，跳转。

体验下搜索功能，速度很快。

看完这些你是不是也很想拥有这样一个博客呢？

只要你认真往下看，10分钟搭建这样一个博客不在话下。

完了后，就可以看见创建的工程文件。

配置及扩展

---

 

Sphinx 的配置文件是 sourceconifg.py

由于修改的内容比较多而杂，为了使这个搭建过程，更加顺畅。

撰写文章

---

 

万事俱备，接下来要写文档了。

在source目录下，新增文件 how_to_be_a_rich_man.rst（至于什么是rst格式呢，请自行搜索引擎噢）

文件内容如下

第一章 如何成为有钱人

======================

1.1 财富继承法

---------------------

有个有钱的老爸。

1.2 财富共享法

---------------------

有个有钱的老婆。

写好文档后，千万记得要把这个文档写进，目录排版里面。

排版配置文件是 sourceindex.rst，千万要注意中间的空行不可忽略。

执行完了后，你可以发现原先的build，不再是空文件夹了。

我们点进去 buildhtml，打开index.html

点击 我们刚写的暴富指南。

发布上线

---

 

托管完成后，我们要发布它，让别人可以访问。

你需要先去 Read the Docs 注册下帐号。

关联一下GitHub

导入代码库。填好与你对应的信息。

构建网页后。右下方，你可以看见你的在线地址。

这里要提醒一下的是，Sphinx的文档格式，默认是 rst 格式，如果你习惯了使用Markdown来写文章，可以使用 Pandoc 这个神器转换一下。

这里给出转换命令。

pandoc -V mainfont="SimSun" -f markdown -t rst hello.md -o hello.rst

或者你也可以在Sphinx上添加支持Markdown渲染的扩展模块及配置。也很简单，但是，我发现使用 md 文件，在网站上的导航无法实现跳转。

到这里，属于你的个人博客就搭建好了，快去试一下吧。

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有