search

agriyakhetarpal / hugo-python-distributions

pip-installable binaries (wheels) for the extended version of the Hugo static site generator with powerful cross-compilation (note: unofficial, community-maintained)
https://pypi.org/project/hugo/
Apache License 2.0
14 stars 1 forks source link

Add documentation #5

Open agriyakhetarpal opened 10 months ago

agriyakhetarpal commented 10 months ago

Some documentation for the project

  1. Get started

    • [x] Usage instructions
    • [x] Multiple installations

  2. Background

    • [x] History and why I created this, and use cases
    • [x] Limitations (there are a lot!)
    • [x] Comparisons with other package managers
    • [x] How this pip-installable distribution can help

See #11 for the above.

  1. Sphinx (closed as not planned since I do not need versioning for this project and won't benefit from the additional maintenance required from hosted Markdown documentation)
    • [ ] Hosted documentation
    • [ ] Add extensions
    • [ ] Versioning if necessary
agriyakhetarpal commented 9 months ago

This package itself can be used to build the current GitHub documentation using a docs-related Hugo theme and then deployed on GitHub Pages