docfx(二)

1. 初始化一個docfx項目

1.建立一個文件夾D:\docfx_walkthroughjson

2.運行cmd 到該文件下執行命令D:\docfx_walkthroughapi

3.輸入命令 docfx init -q  (執行後會生成一個docfx_project的文件夾)markdown

2. 搭建本身的網站

運行命令 docfx docfx_project/docfx.json網站

執行完後會生成一個子文件夾 _site,這就是靜態網站的資源地址。xml

3. 預覽資源網站

運行命令docfx serve docfx_project/_siteblog

若是端口號8080沒有被佔用,那麼網站的運行地址爲 http://localhost:8080資源

若是端口號被佔用了,那麼運行命令 docfx serve _site -p <port>。文檔

4. 修改網站結構

建立更多的md文件到一個指定的文件夾下,爲了組織這些文件夾,咱們須要編輯 toc.yml  文件(位於articles 文件夾下面)get

內容大體以下:cmd

5 . md文件注意事項

md文件的格式主要以 markdown 的基礎語法爲基本,但並非所有都是 markdown 的語法,有些是不同的,以下:

  1.  代碼須要用 ``` 來控制 ,注意 ``` 先後須要空一行。如圖
  2. 爲了自動生成右邊的導航小標題, 你須要在每一個標題前面空一行
  3. 還有一些其餘的能夠參考 官方文檔

6. XML轉 markdown

我寫了一個 xml 文件轉 markdown 文件的程序,基本上是知足80%到90%的語法轉換,就這樣就能夠將一個 xml  文檔的api 轉換成 一docfx 爲基礎的api。

相關文章
相關標籤/搜索