Skip to content
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


Join the chat at jaywcjlove/sb

Blazing-fast static site generator for React, Just write Markdown file. Visit the website for more information.

The documentation site is also a demo example.

Getting Started

It's really easy to get started with rdoc. Just install it as a module and run it to create your website.

Let's get you started!


Install rdoc globally on your system. You’ll need to have Node >= 8 on your local development machine. You can use n to easily switch Node versions between different projects.

npm install rdoc -g

# /usr/local/bin/rdoc -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js
# /usr/local/bin/rdoc-cli -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js

Added rdoc-cli command to resolve Mac integration rdoc command conflicts.

  1. Init Project
rdoc init my-project  # Init project
# or
rdoc-cli init my-project 
  1. Run website
cd my-project && npm install # Install dependencies.
npm start # Into the directory, start the service.
  1. Compile output static HTML resources
npm run build
  1. Configure the deployment URL in package.json
  "scripts": {
    "deploy": "rdoc --publish <your repo url>"
  1. Deploy to Github's gh-pages branch
npm run deploy


Usage: rdoc [options]

Fast static site generator for React.


  -i, init [path]        Create an empty website or reinitialize an existing one.
  -d, --doc <path>       Other documents generated.
  -o, --output <path>    Writes the compiled file to the disk directory. (default: .rdoc-dist)
  -p, --port [number]    The port. (default: 5858)
  --host [host]      The host. (default:
  -b, --branch <branch>  Name of the branch you are pushing to. (default: gh-pages)
  --publish [url]        Other documents generated.
  --build                Creating an optimized production build.
  --clean                Delete the .cache folder.
  -h, --help             output usage information


  $ rdoc init
  $ rdoc init doc-example
  $ rdoc -d doc/mm
  $ rdoc -d tutorial,doc
  $ rdoc -d tutorial,doc --clean --build
  $ rdoc -p 2323  -d doc --clean
  $ rdoc --host -d doc --clean
  $ rdoc --publish https://<your-git-repo>.git --branch master


To develop, run the self-reloading build, Get the code:

$ git clone
$ cd rdoc     # Into the directory
$ npm install # or  yarn install

To develop, run the self-reloading build:

# Run the app
# Restart the app automatically every time code changes. 
# Useful during development.
$ npm run start

Open your browser and visit http://localhost:5858


β”œβ”€β”€ .rdoc-dist
β”œβ”€β”€ package.json
β”œβ”€β”€ src
β”‚Β Β  β”œβ”€β”€ build.js
β”‚Β Β  β”œβ”€β”€ commands
β”‚Β Β  β”œβ”€β”€ conf
β”‚Β Β  β”œβ”€β”€ publish.js
β”‚Β Β  β”œβ”€β”€ server.js
β”‚Β Β  β”œβ”€β”€ utils
β”‚Β Β  └── web
β”œβ”€β”€ templates
β”‚Β Β  └── default # document the static file.
└── theme
    └── default


The MIT License (MIT)

You can’t perform that action at this time.