reStructuredText相關(guān)資源

語法

https://macplay.github.io/posts/cong-markdown-dao-restructuredtext/

http://www.bary.com/doc/a/228277572381775842/#d46f82fd

工具

sphinx:文檔系統(tǒng)
http://www.sphinx-doc.org/en/master/contents.html

nikola:靜太博客系統(tǒng)
https://www.getnikola.com/

netlify: 站點(diǎn)布置
https://www.netlify.com/

使用markdown的靜態(tài)博客系統(tǒng)
mkdocks

hexo

sphinx & github & readthedoc 搭建靜態(tài)博客寫作平臺

sphinx

在wsl中安裝好的python環(huán)境,使用pip 安裝 sphinx,沒什么問題。
按教程的命令新建一個項(xiàng)目。應(yīng)該要先新建一個文件夾。

github

在GITHUB新建一個庫,準(zhǔn)備用來接收SPHINX的項(xiàng)目。

在本地把github上新建立的庫clone下來

這樣,本地的庫就和遠(yuǎn)程庫連接起來了。

進(jìn)入到本地庫目錄,開始創(chuàng)建文檔

sphinx-quickstart

上述命令會在目錄中創(chuàng)建一些文件,包括配置文件和一個make文件。
把內(nèi)容組織好以后,可以直接用make命令得出想要的格式。這里我我用的是

make html

把項(xiàng)目同步到github

前面還還包括設(shè)置git環(huán)境,設(shè)置公鑰等。

# 如果是先在本地建庫,連接到github遠(yuǎn)程庫的話,如下操作
git init
git add .
git commit -m
git remote add origin git@github.com:xxxxx/mybooks
git push -u origin master

# 如果是從遠(yuǎn)程庫克隆回來的庫
git add .
git commit -m 'something'
git push

在github遠(yuǎn)程庫中設(shè)置webhook

我推送上去后,就自動生成了,不知道為什么。試過兩次好象確實(shí)都是自己設(shè)置好了的。

登錄readthedoc

  1. 用github賬號登錄readthedoc
  2. 在項(xiàng)目中選擇github中的庫
    然后會自動deploy
    我在前面幾次失敗了,后來看了這個成功了。https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found

If you have your own conf.py file, it overrides Read the Doc's default conf.py. By default, Sphinx expects the master doc to be contents. Read the Docs will set master doc to index instead (or whatever it is you have specified in your settings). Try adding this to your conf.py:

master_doc = 'index'

后續(xù)操作

  1. 用vscode編輯文件
  2. 在項(xiàng)目文件根目錄下,git三連推。
  3. 在readthedoc項(xiàng)目頁面上,重新構(gòu)建。

目前第三步還沒有成功,不知道為什么。也許要多等一段時間。
readthedoc上應(yīng)該就會自動渲染更新了。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • # Awesome Python [![Awesome](https://cdn.rawgit.com/sindr...
    emily_007閱讀 2,347評論 0 3
  • # Python 資源大全中文版 我想很多程序員應(yīng)該記得 GitHub 上有一個 Awesome - XXX 系列...
    小邁克閱讀 3,130評論 1 3
  • 為子系統(tǒng)中的一組接口提供一個一致的界面,此模式定義了一個高層接口,這個接口使得這一子系統(tǒng)更加容易使用。完美解釋依賴...
    DeerRun閱讀 140評論 0 0
  • 她快,他也快 她慢,他亦慢 她若停下腳步 他絕不勇敢上前 他從來都是默默的跟在她身后 追逐或停駐 卻永遠(yuǎn)都是漫無止...
    周懌夫閱讀 564評論 0 0
  • 寫作就離不開寫事,事件或者故事是多數(shù)文章的主體。 那么怎么寫清楚一件事情呢? 一 按照事件發(fā)展的先后順序進(jìn)行敘述,...
    寫作的技巧閱讀 574評論 0 3

友情鏈接更多精彩內(nèi)容