https://github.com/nate-double-u/technical-documentation-versioning
An exploration of versioning schemes for technical documentation using Hugo and Netlify
https://github.com/nate-double-u/technical-documentation-versioning
documentation versioning
Last synced: 4 months ago
JSON representation
An exploration of versioning schemes for technical documentation using Hugo and Netlify
- Host: GitHub
- URL: https://github.com/nate-double-u/technical-documentation-versioning
- Owner: nate-double-u
- License: cc-by-4.0
- Created: 2021-01-15T21:28:11.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-27T18:36:04.000Z (over 5 years ago)
- Last Synced: 2025-09-12T05:53:54.155Z (10 months ago)
- Topics: documentation, versioning
- Language: HTML
- Homepage: https://technical-documentation-versioning.netlify.app
- Size: 2.94 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Technical Documentation Versioning
An exploration of versioning schemes for technical documentation using Hugo and Netlify.
This presentation was built for the [Cloud Native Computing Foundation](https://www.cncf.io/).
# Build
To build the html, first preview the presentation:
```shell
marp -p slides/documentation-versioning.md
```
Then copy the `documentation-versioning.html` file that was created in the `slides` folder to `index.html` and edit any `../assets` reference to `./assets`.
_Note_: this is done because the presentation format is rendered slightly differently with the preview.
To build the pdf and pptx:
```shell
marp --allow-local-files slides/documentation-versioning.md --pdf --output dist/documentation-versioning.pdf
marp --allow-local-files slides/documentation-versioning.md --pptx --output dist/documentation-versioning.pptx
```
# Meta
This presentation is built using [Marp](https://marp.app/) and is published at https://technical-documentation-versioning.netlify.app.
The research used to build this presentation can be found at [this project's wiki](https://github.com/nate-double-u/technical-documentation-versioning/wiki)
## License
This work is licensed under a [CC-BY-4.0 license](./LICENSE).