<small id='pyo6s'></small> <noframes id='npgGjMY6J'>

  • <tfoot id='3AeX'></tfoot>

      <legend id='ljDG'><style id='CtZn8'><dir id='kZIxBXgj2Q'><q id='Rhf1lCE'></q></dir></style></legend>
      <i id='6v9FBCO'><tr id='CRJDVxvT'><dt id='0EMh'><q id='ZjqBublt'><span id='d7gYGcrbV9'><b id='Ve8m41qPMp'><form id='MYLsEW9u'><ins id='pwaz4DH5'></ins><ul id='ZHe7w4bBs'></ul><sub id='0IZS1nM'></sub></form><legend id='6aYL5WQ'></legend><bdo id='FOcjR'><pre id='0L6F'><center id='gdNvU6I2Q'></center></pre></bdo></b><th id='mcZzNu'></th></span></q></dt></tr></i><div id='1hSvb0mK'><tfoot id='qTGOm'></tfoot><dl id='VYIOqkp'><fieldset id='jKtsgR'></fieldset></dl></div>

          <bdo id='nSf1o'></bdo><ul id='cS6bLXBi'></ul>

          1. <li id='Zeg1q6vz'></li>
            登陆

            章鱼彩票电脑-为你的项目构建高雅的文档,开源文档构建东西——Docusaurus

            admin 2020-02-14 216人围观 ,发现0个评论

            介章鱼彩票电脑-为你的项目构建高雅的文档,开源文档构建东西——Docusaurus绍

            作为程序员都知道有一个叫Github的网站,上面有着不计其数的开源项目,作为开源项意图贡献者们,假如想要取得更多的重视,那么一个好的项目文档或许运用文档无疑是有必要的,这样才能让咱们更简略的去了解项目自身,以及怎么运用,Docusaurus可认为你的开源项目构建一个专归于项目自身的静态文档网站,这一切都变得简略起来!



            Github

            https://github.com/facebook/docusaurus

            作为为开章鱼彩票电脑-为你的项目构建高雅的文档,开源文档构建东西——Docusaurus源项目而生的开源项目,docusaurus取得了13k+的stars,受欢迎程度很高!也是一向处于稳步增长趋势!其V2版别也将提上日程,能够到Github上供给定见和反应!



            相关特性

            • 由Markdown供给支撑

            节省时刻并专心于项意图文档。只需运用Markdown 和Docusaurus 编写文档和博客文章,它们就会发布一组静态html文件,可供运用。


            • 运用React构建

            经过重用React 扩展或自定义项意图布局。能够在重复运用相同的页眉和页脚的一起扩展文档库。


            • 国际化

            本地化已预先装备。运用Crowdin能够将你的文档翻译成70多种语言。



            • 文档版别操控

            文档版别操控可协助你使文档与项目版别坚持同步。


            • 文件查找

            使你的社区轻松地在文档中找到他们所需的内容。很轻松的支撑Algolia文档查找。


            • 快速设置

            快速发动并运转,而不用忧章鱼彩票电脑-为你的项目构建高雅的文档,开源文档构建东西——Docusaurus虑网站规划。


            • 开发和布置

            运用随附的实时服务器进行规划和文档更改。运用脚本或与CircleCI之类的继续集成,将你的网站手动发布到GitHub页面或其他静态文件主机。


            • 网站功用

            Docusaurus当时供给支撑以协助你的网站运用翻译,查找和版别操控,以及一些其他特别文档markdown特性。假如你有实用功用的主意,可随时在GitHub上贡献力量!


            谁正在运用Docusaurus?

            Docusaurus正在为这些项目树立网站,其间不乏许多抢手的开源项目:


            快速开端

            Docusaurus从头开端规划,易于装置,可用来快速发动和运转您的网站,Docusaurus创立了一个简略的脚本,它将设置一切根底架构:

            1、确保您已装置最新版其他Node。咱们还主张您也装置Yarn。

            有必要Node> = 8.x和Yarn> = 1.5上。

            2、创立一个项目(假如不存在),然后将目录更改为该项意图根目录。将在此目录中创立文档。根目录或许包括其他文件。Docusaurus装置脚本将创立两个新目录:docs和website。

            一般,现有的或新建的GitHub项目将成为您的Docusaurus站点的方位,可是运用Docusaurus并不是有必要的。

            3、运转Docusa熟女吧urus装置脚本:

            npx docusaurus-init

            假如没有Node 8.2+,或许期望大局装置Docu章鱼彩票电脑-为你的项目构建高雅的文档,开源文档构建东西——Docusaurussaurus,请运转yarn global add docusaurus-init或npm install --global docusaurus-init。之后,运转docusaurus-init。

            4、验证装置

            除了曾经存在的文件和目录,根目录现在将包括类似于以下内容的结构:


            5、运转示例网站

            依照“装置”部分的阐明运转Docusaurus初始化脚本docusaurus-init之后,具有一个可运转的示例网站,作为网站的根底。运转起来:

            1、cd website

            2、在网站目录中,运用yarn start或npm start运转本地Web服务器。假如没有主动翻开示例站点,则将其加载到本地3000端口。假如现已运用端口3000,则将运用另一个端口。

            应该会在Web浏览器中看到示例站点。还有一个LiveReload服务器正在运转,对网站目录中的文档和文件所做的任何更改都将导致页面改写。会挑选随机生成的默许和辅佐主题色彩。


            6、设置署理

            假如在设置署理,则需求针对开发服务器恳求将其禁用。能够运用NO_PROXY环境变量来完结。

            SET NO_PROXY=localhost

            yarn start (or npm run start)

            7、更新您的Docusaurus版别

            在装置Docusaurus之后的任何时刻,都能够经过进入网站目录并键入

            yarn outdated docusaurus或npm outdated docusaurus

            来查看当时版其他Docusaurus,会看到如下内容:

            8、能够经过以下方法更新到最新版其他Docusaurus:

            yarn upgrade docusaurus --latest 或许 npm update docusaurus


            以上便是入门级其他Docusaurus装置运用方法,具体的装置运用以及发布布置等都能够在官方文档中找到具体的阐明,感兴趣的小伙伴能够参看文档,文档自身就供给了对应的中文版,Enjoy it!


            总结

            Docusaurus是一个专门为开源项目而生的开源项目文档办理项目,功用丰厚,界面漂亮,能够作为静态文档的构建东西也能够当作博客相同运用它,假如你有什么好的主意或许主张,欢迎到谈论区留言共享!

            请关注微信公众号
            微信二维码
            不容错过
            Powered By Z-BlogPHP