Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 898 Bytes

README.adoc

File metadata and controls

46 lines (34 loc) · 898 Bytes

ETCDEV Documentation website generator

Based on Gitbook, downloads all projects in local directory (_sources) and call Gitbook geenrator for each of them, putting result to _target. In addition to that generates home page for the websites.

Configuration

To add a new project edit build.sh and add a full name of the project into the following block:

# Whitelist projects
declare -a projects=(
        ETCDEVTeam/emerald-cli
        ETCDEVTeam/emerald-js
        #ethereumproject/go-ethereum
        #whilei/go-ethereum # just for dev purposes
)

Edit website/data.json to specify details of the project to put into home page.

Run

Install modules:

npm install

Build documentation:

./build.sh -B

Build homepage:

./build.sh -w

View generted documentation:

./build.sh -s