「ReStory」在 Markdown 中自由書寫 React 組件 （Beta）

介紹

先睹爲快

咱們在開發一個小小的 React 組件庫，可是咱們遇到了一個大難題，那就是爲咱們的組件庫書寫一個合理的文檔。

做爲組件文檔，咱們很是但願咱們的組件用例代碼可以展示出來，是的咱們在書寫文檔的時候，可以有直觀的交互體驗。

爲了達到這一點，我開發一款文檔構建工具 ReStory。若是熟悉 Vuepress 的同窗必定不陌生，這能夠說是 Vuepress 的 React 版本。

ReStory 的能力

• 可以直接在 Markdown 文檔中書寫 React 組件，任意的 React 組件
• 一鍵構建服務端渲染和客戶端渲染版本，可以很好的完成 SEO 的任務
• 爲技術文檔而優化的 Markdown 拓展，可以讓你更好的完成組件文檔庫的書寫
• ReStory 構建在 Ant Design 之上，所以，咱們直接在全局使用 Antd，就像例子中同樣！
• 更多能力等你 PR

快速開始

開始使用 ReStory 很是的簡單，就像數 一、二、三、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