Skip to content
This repository has been archived by the owner on Nov 16, 2019. It is now read-only.

Documentation and guide site for the unofficial pgo api's.

License

Notifications You must be signed in to change notification settings

pogodevorg/docs.pogodev.org

Repository files navigation

POGODEV

docs.pogodev.org

Build Status Code Climate Issue Count license

Table of Contents

What is it?

docs.pogodev.org is our open source github pages documentation site backed with Jekyll.

Installation

Requirements

  • Linux / macOS
  • Ruby (> 2.0)

Instructions

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

Documentation

Helper scripts

Main script

  • gen-all : Generate everything from the .proto files in the proto folder. This should be the only script you have to call manually.
./bin/gen-all

Sub-scripts (If the gen-all script fails, PANIC!)

  • 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 for enums and messages (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

Licensing

GNU GPL v3 or later.

Third Party Licenses

None

Contributing

Currently, you can contribute to this project by:

Core Maintainers

Credits

None

About

Documentation and guide site for the unofficial pgo api's.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published