https://github.com/etcdevteam/docs-website
ETCDEV documentation
https://github.com/etcdevteam/docs-website
Last synced: 11 months ago
JSON representation
ETCDEV documentation
- Host: GitHub
- URL: https://github.com/etcdevteam/docs-website
- Owner: ETCDEVTeam
- Created: 2018-02-18T22:47:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-09T03:11:49.000Z (about 8 years ago)
- Last Synced: 2025-06-08T00:49:29.859Z (about 1 year ago)
- Language: Shell
- Homepage: https://docs.etcdevteam.com
- Size: 18.6 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
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
```
Open http://localhost:8000/