vue,ant-design-vue這些框架是拿什麼寫的技術文檔?我們公司需要自己寫自己的文檔,求助?
可以試試:
antvis/gatsby-theme-antv?github.com螞蟻金服數據可視化系列官網的 Gatsby 主題,背靠巨大的 Gatsby 社區,使用 antd 組件 UI 加持,封裝了統一簡單的配置,內建頁頭頁尾布局,靜態預渲染,PWA,主題配置,國際化,markdown 文檔,靈活的菜單生成,文章錨點,可編輯的在線演示,首頁各類 Banner/特性/案例的展示組件。
目前還在光速迭代中,11-22 AntV 系列新官網正式上線,歡迎關注!AntV 官網改造 · Issue #18 · antvis/antvis.github.io
2019-11-22 更新:使用這個主題打造的 AntV 系列新官網發布上線了,我們發布了 G2Plot 圖表,Graphin 圖分析套件,ChartCube 圖表魔方 三個新產品,以及改造了之前的所有產品的首頁,均由 gatsby-theme-antv 進行搭建。
AntV | 螞蟻數據可視化?antv.visiondxqing:知源 · 致遠 - AntV 11.22 年度發布?zhuanlan.zhihu.com我個人還是最喜歡gitbook
你只需要把md傳到GitHub即可
就針對支持github這一項來說,秒殺語雀等
更別說支持自定義域名了
個人不喜歡gatsby或者vuepress等,雖然我曾經是gatsby的組織成員,但是那時候是因為我對graphql感興趣而已::&>_&
那你一定是需要這個了,Vue官方的文檔網站生成器
介紹 | VuePress
這個我給題主推薦一下,其實下面已經有人說了,是vuepress
VuePress 中文文檔 | VuePress 中文網?www.vuepress.cn不過我推薦的理由是,我最近就用這個給公司搭建了產品手冊文檔。體會了一下其方便性。
關鍵是,本人是產品設計師的角色,並沒有很多coding基礎,但是按照教程來,一步一步,很快也完成了,後續更新也是得心應手。
用vuepress的好處總結一下有如下幾個
- 通過markdown本地創建和維護文檔,方便更新和遷移。
- 本地文檔可方便地通過github等代碼管理版本管理工具來管理。
- 可以生成html的靜態文檔,方便發布。
- vuepress原生的模板顏值也不錯,響應式的布局,還支持搜索。
需要具備的一些知識
- 一些基本的命令行操作(推薦使用mac系統或者linux)
- 一些寫代碼的軟體(推薦vscode,不要用記事本啊朋友)
- 了解一些git的知識和操作(為了方便代碼管理和備份)
基本就是這樣了,歡迎交流
yinyu.name
試試我寫的 rcpress https://github.com/YvesCoding/rcpress
模仿的vuepress 不過是基於的react
主題是使用ant design搭建的
vue-press
vuepress或docsify。
我自己用docsify寫的,基本沒有學習成本,會寫md就一頓狂寫就完事了。
不知道你有沒有發現
其他答主的回答截圖裡 使用了很多 chrome 插件.....
求人不如求己 去搜索 chrome 插件 網站技術棧 ... 關鍵詞
以後遇到喜歡的網站 就無需再問
除了上述答主說的之外,我推一個
docsify?docsify.js.org簡單易用好上手,樣式我覺得也很不錯
具體問題具體分析,先弄清你要寫啥,自然能找到數不清的解決方案。
要是只寫寫字,畫畫表格,markdown-it及其周邊現成的東西就足夠用了。
輸出組件和對應代碼,可以自定義loader載入,用vue-loader當組件載入一遍,再用raw-loader輸出一遍源碼,再找個代碼高亮的高亮下代碼,最後再把源碼和組件包裹成一個組件。
如果需要在線編輯,看下各個線上IDE的REST API文檔,弄個按鈕集成到上面寫的組件就成。
如果需要在頁面上調整參數,直接預覽,可以用一些現成的框架,比如storybook的knobs https://github.com/storybookjs/storybook/tree/next/addons/knobs
推薦閱讀: