介紹

先睹為快

我們在開發一個小小的 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