RDoc幫助你生成靜態網站，你只需要寫Markdown

nidaye 發布于2019-08-22 13:59 / 640人閱讀

摘要：是一個文檔生成工具，用于生成文檔網站或簡單的博客網站。簡單到你只需寫文件就可以幫助你生成網站。官方網站開源下圖官方網站，是生成的基于的快速靜態站點生成器，只需編寫文件即可。訪問網站獲取更多信息。部署網站恭喜你，你已經生成了一個網站。

RDoc 是一個文檔生成工具，用于生成文檔網站或簡單的博客網站。
簡單到你只需寫 Markdown 文件就可以幫助你生成網站。
同時可以方便的集成到你的項目工程中。

官方網站

開源Github

下圖官方網站，是 rdoc 生成的：

基于React的快速靜態站點生成器，只需編寫Markdown文件即可。訪問react-doc.github.io網站獲取更多信息。

快速開始

在您的系統上全局安裝rdoc。需要在本地開發機器上具有Node> = 8。您可以使用 n 來輕松切換不同項目之間的Node版本。

全局安裝

npm install rdoc -g

初始化網站

rdoc init my-project  # Init project

運行網站

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 實例，將當前工程生成的靜態 push 到 https://github.com/react-doc/react-doc.github.io.git 倉庫的 master 分支中。

--branch master 參數指定分支，默認沒有這個參數，推向指定網站的 gh-pages 分支。

部署網站

npm run deploy

恭喜你，你已經生成了一個網站。?

云服務器 GPU云服務器你只需要幫助你靜態網站需要服務器嗎生成靜態

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/92708.html

打造數據科學作品集：搭建一個數據科學博客

摘要：讀完本文，你將學會如何使用靜態網站生成器，搭建一個屬于自己的博客，用來展示數據科學作品。靜態網站基本上，一個靜態網站就是一個全是文件的文件夾。建立靜態網站的一種方法是手寫，然后上傳所有的文件到服務器。這是「打造數據科學作品集」系列文章的第二篇。如果你喜歡該系列，而且想知道下一篇文章什么時候發布，你可以訂閱我們。讀完本文，你將學會如何使用 Pelican 靜態網站生成器，搭建一個屬于...

iamyoung001 2019-07-25 10:50 評論0 收藏0
使用Api-blueprint文檔創建mock server

摘要：是一套描述標準，和一樣，屬于一種標記語言，可以把標記文稿轉換成漂亮的接口文檔。還可以創建，進行本地調試。一語法只要用寫過東西基本很快就能掌握語法。參考文檔使用編寫文檔用生成優雅的文檔指導手冊用生成優雅的文檔前后端配合開發的時候，常常會有這樣一種需求：你接口定義好了嗎？能不能先幫我起一個 Mock Server 先跑起來？那么，如何才能避免前后端開發在時間差上的無謂等待呢？api-bl...

ningwang 2019-07-24 10:34 評論0 收藏0
使用 Hexo 創建項目文檔網站

摘要：而且通常來說，是用來介紹項目，而不是展示文檔。如果不確定系統中是否已經安裝了，使用下面的命令檢查如果出現了的版本號，則不需要再安裝了。例如我執行的命令如下然后使用進入項目目錄，并創建一個名為的目錄目錄將存放我們的文檔。當我們發布一個開源項目的時候，最重要的事情之一就是要創建項目文檔。對使用項目的用戶來說，文檔是非常有必要的，通常我們可以使用下面這些方式來創建文檔： GitHub W...

mikasa 2019-08-01 17:05 評論0 收藏0
我是如何進行Spring MVC文檔翻譯項目的環境搭建、項目管理及自動化構建工作的

摘要：內容包括翻譯環境搭建項目管理與自動化構建三部分。博客首頁聲明官方文檔翻譯稿發布托管在七牛上的翻譯文檔倉庫環境搭建翻譯與寫作一樣，首要之事均為專注于翻譯寫作本身，而不考慮樣式等方面。安裝完成后，運行即可在啟動一個本地的。感興趣的同學可以關注這個翻譯項目、我的博客原文和我的Github showImg(/img/remote/1460000006776466); 前段時間翻譯的S...

shevy 2019-08-14 14:14 評論0 收藏0