DOCS.9FRONT.ORG UNOFFICIAL MIRROR OF DOCS.A-B.XYZ

9FRONT DOCS

This is “docs”, a repository of live documents covering plan9/front theory, usage, and development.

ACHTUNG! This is a work-in-progress prototype. See the technical details.

Springboards

HOWTO
TODO

Reading

Document updates are periodically fetched by the backend, which renders the document tree and makes it available for reading via 9p and HTTP.

9p

On Plan 9, run:

9fs tcp!docs.a-b.xyz!909 /n/docs

HTTP

Visit docs.a-b.xyz with a web browser.

Contributing

The document source repository is currently hosted and available for browsing here.

Get it locally for reading:

git/clone https://git.sr.ht/~kvik/docs.9front.org

For reading and writing:

git/clone ssh://git@git.sr.ht/~kvik/docs.9front.org

Everyone is invited to get write access by asking (kvik) on IRC, grid, or kvik@a-b.xyz. Otherwise you may submit patches through contribution mechanisms on sr.ht, by sending a mail to the 9front@9front.org mailing list, or communicating with your favorite editor.

Contributed documents are mostly expected to be markdown-formatted files, denoted by the .md file extension.

The formatting syntax used by the markdown processor discount used by the backend is documented in the manual page markdown(6).

Additionally, plain text files and HTML documents may be entered into the repository with file extensions .txt and .shtml, respectively. These will be copied verbatim into the rendered document tree.

Warning only one of a.md, a.txt, or a.shtml may exist at the same time. Otherwise the document generation will fail. This is a problem with the current implementation and may be fixed in the future.

Images and other static content is best hosted outside this repository. Dedicated upload and stable link space may be provided later.