摘要:是一個文檔生成工具,用于生成文檔網(wǎng)站或簡單的博客網(wǎng)站。簡單到你只需寫文件就可以幫助你生成網(wǎng)站。官方網(wǎng)站開源下圖官方網(wǎng)站,是生成的基于的快速靜態(tài)站點生成器,只需編寫文件即可。訪問網(wǎng)站獲取更多信息。部署網(wǎng)站恭喜你,你已經(jīng)生成了一個網(wǎng)站。
RDoc 是一個文檔生成工具,用于生成文檔網(wǎng)站或簡單的博客網(wǎng)站。
簡單到你只需寫 Markdown 文件就可以幫助你生成網(wǎng)站。
同時可以方便的集成到你的項目工程中。
官方網(wǎng)站
開源Github
下圖官方網(wǎng)站,是 rdoc 生成的:
基于React的快速靜態(tài)站點生成器,只需編寫Markdown文件即可。 訪問react-doc.github.io網(wǎng)站獲取更多信息。
快速開始在您的系統(tǒng)上全局安裝rdoc。需要在本地開發(fā)機器上具有Node> = 8。 您可以使用 n 來輕松切換不同項目之間的Node版本。
全局安裝npm install rdoc -g初始化網(wǎng)站
rdoc init my-project # Init project運行網(wǎng)站
cd my-project && npm start # Into the directory, start the service. ## Compiled successfully! ## You can now view doc-example in the browser. ## Local: http://localhost:5858/ ## On Your Network: http://192.168.188.109:5858/ ## Note that the development build is not optimized. ## To create a production build, use npm run build.編譯生成HTML
npm run build修改部署配置
在 package.json 中配置部署URL
{ "scripts": { "deploy": "rdoc --publish <您的GitHub倉庫地址>" ... }, ... }
例如:
{ "scripts": { "deploy": "rdoc --publish https://github.com/react-doc/react-doc.github.io.git --branch master" ... }, ... }
上面 deploy 實例,將當(dāng)前工程生成的靜態(tài) push 到 https://github.com/react-doc/react-doc.github.io.git 倉庫的 master 分支中。
--branch master 參數(shù)指定分支,默認(rèn)沒有這個參數(shù),推向指定網(wǎng)站的 gh-pages 分支。
部署網(wǎng)站npm run deploy
恭喜你,你已經(jīng)生成了一個網(wǎng)站。?
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/92708.html
摘要:讀完本文,你將學(xué)會如何使用靜態(tài)網(wǎng)站生成器,搭建一個屬于自己的博客,用來展示數(shù)據(jù)科學(xué)作品。靜態(tài)網(wǎng)站基本上,一個靜態(tài)網(wǎng)站就是一個全是文件的文件夾。建立靜態(tài)網(wǎng)站的一種方法是手寫,然后上傳所有的文件到服務(wù)器。 這是「打造數(shù)據(jù)科學(xué)作品集」系列文章的第二篇。如果你喜歡該系列,而且想知道下一篇文章什么時候發(fā)布,你可以訂閱我們。讀完本文,你將學(xué)會如何使用 Pelican 靜態(tài)網(wǎng)站生成器,搭建一個屬于...
摘要:是一套描述標(biāo)準(zhǔn),和一樣,屬于一種標(biāo)記語言,可以把標(biāo)記文稿轉(zhuǎn)換成漂亮的接口文檔。還可以創(chuàng)建,進行本地調(diào)試。一語法只要用寫過東西基本很快就能掌握語法。參考文檔使用編寫文檔用生成優(yōu)雅的文檔指導(dǎo)手冊用生成優(yōu)雅的文檔 前后端配合開發(fā)的時候,常常會有這樣一種需求:你接口定義好了嗎?能不能先幫我起一個 Mock Server 先跑起來?那么,如何才能避免前后端開發(fā)在時間差上的無謂等待呢?api-bl...
摘要:而且通常來說,是用來介紹項目,而不是展示文檔。如果不確定系統(tǒng)中是否已經(jīng)安裝了,使用下面的命令檢查如果出現(xiàn)了的版本號,則不需要再安裝了。例如我執(zhí)行的命令如下然后使用進入項目目錄,并創(chuàng)建一個名為的目錄目錄將存放我們的文檔。 當(dāng)我們發(fā)布一個開源項目的時候,最重要的事情之一就是要創(chuàng)建項目文檔。對使用項目的用戶來說,文檔是非常有必要的,通常我們可以使用下面這些方式來創(chuàng)建文檔: GitHub W...
摘要:內(nèi)容包括翻譯環(huán)境搭建項目管理與自動化構(gòu)建三部分。博客首頁聲明官方文檔翻譯稿發(fā)布托管在七牛上的翻譯文檔倉庫環(huán)境搭建翻譯與寫作一樣,首要之事均為專注于翻譯寫作本身,而不考慮樣式等方面。安裝完成后,運行即可在啟動一個本地的。 感興趣的同學(xué)可以關(guān)注這個翻譯項目 、 我的博客原文 和 我的Github showImg(/img/remote/1460000006776466); 前段時間翻譯的S...
閱讀 4080·2021-11-23 10:09
閱讀 1368·2021-11-23 09:51
閱讀 2982·2021-11-23 09:51
閱讀 1630·2021-09-07 09:59
閱讀 2396·2019-08-30 15:55
閱讀 2335·2019-08-30 15:55
閱讀 2986·2019-08-30 15:52
閱讀 2588·2019-08-26 17:04