摘要:介紹先睹為快我們在開發(fā)一個(gè)小小的組件庫,但是我們遇到了一個(gè)大難題,那就是為我們的組件庫書寫一個(gè)合理的文檔。為了達(dá)到這一點(diǎn),我開發(fā)一款文檔構(gòu)建工具。
介紹
先睹為快
我們在開發(fā)一個(gè)小小的 React 組件庫,但是我們遇到了一個(gè)大難題,那就是為我們的組件庫書寫一個(gè)合理的文檔。
作為組件文檔,我們非常希望我們的組件用例代碼能夠展現(xiàn)出來,是的我們在書寫文檔的時(shí)候,能夠有直觀的交互體驗(yàn)。
為了達(dá)到這一點(diǎn),我開發(fā)一款文檔構(gòu)建工具 ReStory。如果熟悉 Vuepress 的同學(xué)一定不陌生,這可以說是 Vuepress 的 React 版本。
ReStory 的能力能夠直接在 Markdown 文檔中書寫 React 組件,任意的 React 組件
一鍵構(gòu)建服務(wù)端渲染和客戶端渲染版本,能夠很好的完成 SEO 的任務(wù)
為技術(shù)文檔而優(yōu)化的 Markdown 拓展,能夠讓你更好的完成組件文檔庫的書寫
ReStory 構(gòu)建在 Ant Design 之上,因此,我們直接在全局使用 Antd,就像例子中一樣!
更多能力等你 PR
快速開始開始使用 ReStory 非常的簡單,就像數(shù) 1、2、3、4一樣。
# 安裝 ReStory,你可能需要一些權(quán)限 (sudo) npm config set unsafe-perm true && npm i -g restory # 構(gòu)建一個(gè) md 文件 echo "# Hello ReStory" > README.md # 輸入全局命令,注意命令的最后有一個(gè)小點(diǎn)~ restory dev . # 當(dāng)你書寫完成以后構(gòu)建,輸入全局命令,注意命令的最后有一個(gè)小點(diǎn)~ restory build .
項(xiàng)目地址:ReStory
文檔鏈接(目前只有英文):Document
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://specialneedsforspecialkids.com/yun/52347.html
摘要:介紹先睹為快我們在開發(fā)一個(gè)小小的組件庫,但是我們遇到了一個(gè)大難題,那就是為我們的組件庫書寫一個(gè)合理的文檔。為了達(dá)到這一點(diǎn),我開發(fā)一款文檔構(gòu)建工具。 介紹 先睹為快showImg(https://segmentfault.com/img/remote/1460000014854151); 我們在開發(fā)一個(gè)小小的 React 組件庫,但是我們遇到了一個(gè)大難題,那就是為我們的組件庫書寫一個(gè)合理...
摘要:前端項(xiàng)目如何管理前端項(xiàng)目的管理分為兩個(gè)維度項(xiàng)目內(nèi)的管理與多項(xiàng)目之間的管理。具體可以參考項(xiàng)目如何進(jìn)行多人協(xié)作開發(fā)。組件項(xiàng)目更不用說了,值得提一下的是組件項(xiàng)目的版本號應(yīng)當(dāng)符合語義化版本規(guī)范。 前端項(xiàng)目如何管理 前端項(xiàng)目的管理分為兩個(gè)維度:項(xiàng)目內(nèi)的管理與多項(xiàng)目之間的管理。 1. 項(xiàng)目內(nèi)的管理 在一個(gè)項(xiàng)目內(nèi),當(dāng)有多個(gè)開發(fā)者一起協(xié)作開發(fā)時(shí),或者功能越來越多、項(xiàng)目越來越龐大時(shí),保證項(xiàng)目井然有序的進(jìn)...
摘要:將處理所有相關(guān)的東西并且在上部署該文件。這里將使用上一節(jié)已經(jīng)創(chuàng)建的文件。使用構(gòu)建應(yīng)用使用構(gòu)建同樣非常簡單。使用構(gòu)建包如要使用打包項(xiàng)目,只需在終端中執(zhí)行命令,即可在項(xiàng)目目錄中得到文件夾。其在社區(qū)也得到了廣泛的使用。 譯者注:最近看到 Poi 這個(gè)也是打著零配置特點(diǎn)(Parcel:莫名躺槍?)的 JavaScript 打包工具,發(fā)現(xiàn)其在 Github 有著 3000+ Star 的同時(shí)在中...
閱讀 2062·2023-04-25 21:11
閱讀 2963·2021-09-30 09:47
閱讀 2272·2021-09-24 09:48
閱讀 4428·2021-08-23 09:43
閱讀 895·2019-08-30 15:54
閱讀 559·2019-08-28 18:01
閱讀 1397·2019-08-27 10:55
閱讀 588·2019-08-27 10:55