Skip to content

Timberborn-Modding-Central/TimberAPI_Docs

Repository files navigation

Contributing to the TimberAPI docs

You can contribute to the TimberAPI documentation by editing or creating files inside the documentation folder. Create a new branch and request for a pull request.

Setting up local environment

If you want to edit a lot of pages and/or do some more complex changes it's recommended to set up a local environment to see your changes in action before pushing it.

  1. Clone the TimberAPI_Docs
  2. Install the newest Ruby + Devkit
  3. Install RubyGem
    For more detailed installation of Jekyll go to the Jekyll Docs
  4. Run the command bundle exec jekyll serve
  5. Browse to http://localhost:4000