摘要:介紹先睹為快我們在開發一個小小的組件庫,但是我們遇到了一個大難題,那就是為我們的組件庫書寫一個合理的文檔。為了達到這一點,我開發一款文檔構建工具。
介紹
先睹為快
我們在開發一個小小的 React 組件庫,但是我們遇到了一個大難題,那就是為我們的組件庫書寫一個合理的文檔。
作為組件文檔,我們非常希望我們的組件用例代碼能夠展現出來,是的我們在書寫文檔的時候,能夠有直觀的交互體驗。
為了達到這一點,我開發一款文檔構建工具 ReStory。如果熟悉 Vuepress 的同學一定不陌生,這可以說是 Vuepress 的 React 版本。
ReStory 的能力能夠直接在 Markdown 文檔中書寫 React 組件,任意的 React 組件
一鍵構建服務端渲染和客戶端渲染版本,能夠很好的完成 SEO 的任務
為技術文檔而優化的 Markdown 拓展,能夠讓你更好的完成組件文檔庫的書寫
ReStory 構建在 Ant Design 之上,因此,我們直接在全局使用 Antd,就像例子中一樣!
更多能力等你 PR
快速開始開始使用 ReStory 非常的簡單,就像數 1、2、3、4一樣。
# 安裝 ReStory,你可能需要一些權限 (sudo) npm config set unsafe-perm true && npm i -g restory # 構建一個 md 文件 echo "# Hello ReStory" > README.md # 輸入全局命令,注意命令的最后有一個小點~ restory dev . # 當你書寫完成以后構建,輸入全局命令,注意命令的最后有一個小點~ restory build .
項目地址:ReStory
文檔鏈接(目前只有英文):Document
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/94987.html
摘要:介紹先睹為快我們在開發一個小小的組件庫,但是我們遇到了一個大難題,那就是為我們的組件庫書寫一個合理的文檔。為了達到這一點,我開發一款文檔構建工具。 介紹 先睹為快showImg(https://segmentfault.com/img/remote/1460000014854151); 我們在開發一個小小的 React 組件庫,但是我們遇到了一個大難題,那就是為我們的組件庫書寫一個合理...
摘要:將處理所有相關的東西并且在上部署該文件。這里將使用上一節已經創建的文件。使用構建應用使用構建同樣非常簡單。使用構建包如要使用打包項目,只需在終端中執行命令,即可在項目目錄中得到文件夾。其在社區也得到了廣泛的使用。 譯者注:最近看到 Poi 這個也是打著零配置特點(Parcel:莫名躺槍?)的 JavaScript 打包工具,發現其在 Github 有著 3000+ Star 的同時在中...
閱讀 3796·2021-09-23 11:32
閱讀 2463·2021-09-06 15:01
閱讀 1623·2021-08-18 10:24
閱讀 3458·2019-12-27 11:44
閱讀 3609·2019-08-30 15:52
閱讀 2518·2019-08-30 11:11
閱讀 689·2019-08-29 17:27
閱讀 605·2019-08-29 16:22