https://github.com/gopad/gopad-docs
Documentation for the Gopad project
https://github.com/gopad/gopad-docs
docs documentation etherpad gopad hugo
Last synced: 10 months ago
JSON representation
Documentation for the Gopad project
- Host: GitHub
- URL: https://github.com/gopad/gopad-docs
- Owner: gopad
- License: cc-by-sa-4.0
- Created: 2018-01-02T23:15:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-03T19:37:14.000Z (about 1 year ago)
- Last Synced: 2025-04-03T20:32:10.805Z (about 1 year ago)
- Topics: docs, documentation, etherpad, gopad, hugo
- Language: HTML
- Homepage: https://gopad.eu
- Size: 963 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Gopad: Documentation
[](https://github.com/gopad/gopad-docs/actions/workflows/general.yml) [](https://matrix.to/#/#gopad:matrix.org) [](https://app.codacy.com/gh/gopad/gopad-docs/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
Documentation for the Gopad project including the related tools and clients,
you can find this website at [gopad.eu][website].
## Hosting
The website is hosted on [Netlify][netlify], the website gets
automatically updated on every push to the `master` branch.
## Install
This website uses the [Hugo][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][install] to get Hugo up and running.
## Development
To generate the website and serve it on [localhost:1313](http://localhost:1313)
just execute this command and stop it with `Ctrl+C`:
```console
npm install --ci
hugo 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
[gopad@webhippie.de](mailto:gopad@webhippie.de) first.
## Contributing
Fork -> Patch -> Push -> Pull Request
## Authors
- [Thomas Boerger](https://github.com/tboerger)
## License
CC-BY-SA-4.0
## Copyright
```console
Copyright (c) 2018 Thomas Boerger
```
[website]: https://gopad.eu
[netlify]: https://www.netlify.co
[hugo]: https://github.com/spf13/hugo
[install]: https://gohugo.io/overview/installing/