RDoc帮助你生成静态网站，你只需要写Markdown

nidaye 发布于2019-08-22 13:59 / 524人阅读

摘要：是一个文档生成工具，用于生成文档网站或简单的博客网站。简单到你只需写文件就可以帮助你生成网站。官方网站开源下图官方网站，是生成的基于的快速静态站点生成器，只需编写文件即可。访问网站获取更多信息。部署网站恭喜你，你已经生成了一个网站。

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

恭喜你，你已经生成了一个网站。?

idc机房托管混合云你只需要帮助你静态网站需要服务器吗生成静态

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/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