Skip to content

katzenpost/website

Repository files navigation

Katzenpost Website

Source for katzenpost.network, built with Hugo and the Docsy theme. Deployed by Netlify (see netlify.toml).

Local preview

Prerequisites: Node.js (>= 22) and a Go toolchain (Hugo fetches the Docsy theme as a Hugo module on first build).

npm ci
npx hugo server

Then browse http://localhost:1313/. Add --bind 0.0.0.0 to the server command when browsing from a different machine.

No system-wide Hugo is needed, and distro packages are usually too old anyway: npm ci installs the pinned hugo-extended binary into node_modules, along with the PostCSS toolchain the build requires. A build without npm ci fails with "You need to install PostCSS".

To produce a production build in public/, run npx hugo.

Do not use npm run serve or npm run build: those scripts are inherited from upstream Docsy and reference a userguide directory this repository does not have.

Content

Documentation lives under content/en/docs/.

Two pages are machine-generated and must not be edited directly:

  • content/en/docs/misc/thin_client_api_reference.md, generated by tools/thin-client-api-gen/
  • content/en/docs/misc/python_thin_client_api.md, generated by tools/python-api-gen/

Edit the binding docstrings, groups.yaml, or the overlay/ fragments instead, then regenerate; each generator directory has a README with instructions.

About

Website for Katzenpost project

Resources

Stars

2 stars

Watchers

7 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors