Gopad: Documentation

Documentation for the Gopad project including the related tools and clients, you can find this website at gopad.eu.

Hosting

The website is hosted on Netlify, the website gets automatically updated on every push to the master branch.

Install

This website uses the Hugo static site generator. If you are planning to contribute you'll want to download and install Hugo on your local machine. The installation of Hugo is out of the scope of this document, so please take the official install instructions to get Hugo up and running.

Development

To generate the website and serve it on localhost:1313 just execute this command and stop it with Ctrl+C:

make server

When you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.

Security

If you find a security issue please contact [email protected] first.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

• Thomas Boerger

License

CC-BY-SA-4.0

Copyright

Copyright (c) 2018 Thomas Boerger <[email protected]>