docs.pogodev.org
is our open source github pages documentation site backed with Jekyll.
- Linux / macOS
- Ruby (> 2.0)
Set up your project in your code directory
git clone https://github.com/pogodevorg/docs.pogodev.org.git
cd docs.pogodev.org
Install dependencies
./bin/setup
Run the server and watch for changes in your files
./bin/server
gen-all
: Generate everything from the.proto
files in theproto
folder. This should be the only script you have to call manually.
./bin/gen-all
- proto2yml : Create a
.yml
file out of a.proto
file
./bin/proto2yml proto/v0.33.0.proto > _data/api_latest.yml
- ymlapi2md : Create default
.md
files forenums
andmessages
(templates used are in./templates
)
./bin/ymlapi2md _data/api_latest.yml
- ymlapi2changelog : Create default changelog
.md
files between 2 versions of the API (templates used are in./templates
)
./bin/ymlapi2changelog _data/api_0_31_0.yml _data/api_0_33_0.yml
GNU GPL v3 or later.
None
Currently, you can contribute to this project by:
- Submitting a detailed issue.
- Forking the project, and sending a pull request back to for review.
None