Rayhaan JaufeerallyandClaude Opus 5.5
dc275f99d7
The documentation moves from READMEs into a site in docs/: getting started, a user guide, operations, a reference, and development pages, written in the style of network vendors' documentation (docs/STYLE.md). bin/bgp/README.md and docs/RFCs.md are folded into it. - A theme of its own in the International Typographic Style, in blues, with self-hosted Inter and JetBrains Mono, search over Zola's index, dark mode, and no resources loaded from other hosts. - Example configurations in docs/examples/, shown on the pages and checked with `bgp --check` in CI. - A test that fails when a field of config.proto is missing from the configuration reference. - A CI job that builds the site; Zola fails on broken links and anchors. - A hardened systemd unit, tried under systemd with kernel routes on. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
49 lines
1.6 KiB
TOML
49 lines
1.6 KiB
TOML
# The documentation site for ferrix, built with Zola (https://www.getzola.org).
|
|
#
|
|
# zola --root docs serve # http://127.0.0.1:1111, rebuilt on every change
|
|
# zola --root docs build # into docs/public
|
|
#
|
|
# base_url is where the site is published. `zola build --base-url ...`
|
|
# overrides it for a build elsewhere.
|
|
base_url = "https://ferrix.rayhaan.net"
|
|
title = "Ferrix BGP"
|
|
description = "Ferrix is a BGP daemon for Linux routers. It filters received routes, validates them with the RPKI, prevents route leaks with BGP roles, and installs the best paths in the kernel."
|
|
default_language = "en"
|
|
|
|
compile_sass = true
|
|
minify_html = false
|
|
generate_feeds = false
|
|
build_search_index = true
|
|
|
|
[markdown]
|
|
smart_punctuation = false
|
|
github_alerts = true
|
|
insert_anchor_links = "heading"
|
|
|
|
# Code is coloured by the site's own stylesheet: the highlighter only marks
|
|
# what each token is (style "class"). It also writes a giallo.css of the
|
|
# theme named here into static/, which the site does not use.
|
|
[markdown.highlighting]
|
|
theme = "github-light"
|
|
style = "class"
|
|
# The configuration's own format, which the highlighter does not know.
|
|
extra_grammars = ["syntaxes/textproto.json"]
|
|
|
|
[search]
|
|
index_format = "elasticlunr_javascript"
|
|
include_title = true
|
|
include_description = true
|
|
include_content = true
|
|
truncate_content_length = 4000
|
|
|
|
[extra]
|
|
repository = "https://git.rayhaan.net/rayhaan/ferrix"
|
|
version = "0.1.0"
|
|
|
|
# The top bar.
|
|
nav = [
|
|
{ name = "Docs", path = "docs/getting-started/introduction/" },
|
|
{ name = "Configuration", path = "docs/reference/configuration/" },
|
|
{ name = "RFCs", path = "docs/reference/rfcs/" },
|
|
]
|