Vauchi Docs

Mirror: This repo is a read-only mirror of gitlab.com/vauchi/docs. Please open issues and merge requests there.

The source of the Vauchi user and developer documentation, published at vauchi.app/docs. It is an mdBook; the pages are in src/.

The protocol specification lives in vauchi/spec, the code in vauchi/core.

Build

Needs mdbook 0.4 (CI pins 0.4.44; 0.5 breaks the build), mdbook-admonish, python3 and node, for the preprocessors in book.toml:

npm ci
mdbook serve

GPL-3.0-or-later; see LICENSE and REUSE.toml.

Name		Name	Last commit message	Last commit date
LICENSES		LICENSES
ci/tests		ci/tests
scripts		scripts
src		src
theme		theme
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
.markdownlint.json		.markdownlint.json
CODEOWNERS		CODEOWNERS
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
REUSE.toml		REUSE.toml
_typos.toml		_typos.toml
ascii-diagram.js		ascii-diagram.js
book.toml		book.toml
justfile		justfile
mdbook-admonish.css		mdbook-admonish.css
mdbook-beautiful-mermaid.mjs		mdbook-beautiful-mermaid.mjs
mermaid-init.js		mermaid-init.js
mermaid.min.js		mermaid.min.js
nginx.conf		nginx.conf
package-lock.json		package-lock.json
package.json		package.json
theme-switcher.js		theme-switcher.js