mirror of
https://github.com/kernelkit/infix.git
synced 2026-07-22 01:13:00 +02:00
Joachim Wiberg
b341d37267
DNS does not allow CNAME records at an apex domain (e.g. kernelkit.org), so GitHub Pages cannot reliably redirect kernelkit.github.io to it. A www subdomain can carry a CNAME pointing directly to kernelkit.github.io, giving GitHub full control over the mapping and making the redirect work. Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
176 lines
4.5 KiB
YAML
176 lines
4.5 KiB
YAML
site_name: User's Guide
|
|
site_description: Infix Documentation
|
|
site_url: https://kernelkit.github.io/infix/
|
|
repo_url: https://github.com/kernelkit/infix/
|
|
repo_name: kernelkit/infix
|
|
copyright: Copyright © 2022-2025 The KernelKit Team
|
|
docs_dir: doc/
|
|
edit_uri: edit/master/doc/
|
|
extra_css:
|
|
- extra.css
|
|
|
|
exclude_docs: |
|
|
ChangeLog.md
|
|
cli/README.md
|
|
README.md
|
|
TODO.org
|
|
|
|
nav:
|
|
- Introduction: index.md
|
|
- CLI:
|
|
- Introduction: cli/introduction.md
|
|
- Configuration: cli/configure.md
|
|
- Keybindings: cli/keybindings.md
|
|
- Network Calculator: cli/netcalc.md
|
|
- Network Monitoring: cli/tcpdump.md
|
|
- Quickstart Guide: cli/quick.md
|
|
- Text Editor: cli/text-editor.md
|
|
- Upgrading: cli/upgrade.md
|
|
- Docker Containers: container.md
|
|
- Networking:
|
|
- Overview: networking.md
|
|
- Common Settings: iface.md
|
|
- Bridging: bridging.md
|
|
- Link Aggregation: lag.md
|
|
- Ethernet Interfaces: ethernet.md
|
|
- IP Addressing: ip.md
|
|
- Routing: routing.md
|
|
- Firewall Configuration: firewall.md
|
|
- Quality of Service: qos.md
|
|
- RMON Counters: eth-counters.md
|
|
- Tunneling (L2/L3): tunnels.md
|
|
- VPN Tunnels:
|
|
- Overview: vpn.md
|
|
- WireGuard: vpn-wireguard.md
|
|
- Wireless LAN (WiFi): wifi.md
|
|
- Services:
|
|
- Device Discovery: discovery.md
|
|
- DHCP Server: dhcp.md
|
|
- NTP Server: ntp.md
|
|
- System:
|
|
- Boot Procedure: boot.md
|
|
- Configuration: system.md
|
|
- Access Control (NACM): nacm.md
|
|
- Hardware Info & Status: hardware.md
|
|
- Management: management.md
|
|
- Keystore: keystore.md
|
|
- Syslog Support: syslog.md
|
|
- Support Data: support.md
|
|
- Upgrade: upgrade.md
|
|
- Scripting:
|
|
- Introduction: scripting.md
|
|
- Legacy Scripting: scripting-sysrepocfg.md
|
|
- NETCONF Scripting: scripting-netconf.md
|
|
- RESTCONF Scripting: scripting-restconf.md
|
|
- Production Testing: scripting-prod.md
|
|
- Developer's Corner:
|
|
- Branding & Releases: branding.md
|
|
- Developer's Guide: developers-guide.md
|
|
- Developing with Buildroot: override-package.md
|
|
- Netboot HowTo: netboot.md
|
|
- Regression Testing: testing.md
|
|
- Test System Architecture: test-arch.md
|
|
- Virtual Environments: virtual.md
|
|
- Vital Product Data (VPD): vpd.md
|
|
- Origin & Licensing: license.md
|
|
|
|
theme:
|
|
logo: logo-plain.png
|
|
name: material
|
|
features:
|
|
- toc.follow
|
|
# - toc.integrate
|
|
- navigation.path
|
|
- navigation.instant
|
|
- navigation.instant.progress
|
|
- navigation.tracking
|
|
- navigation.indexes
|
|
# - navigation.tabs
|
|
# - navigation.sections
|
|
# - navigation.expand
|
|
# - navigation.top
|
|
# - navigation.footer
|
|
- search.highlight
|
|
- search.share
|
|
# - content.action.edit
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.footnote.tooltips
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: orange
|
|
accent: orange
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: black
|
|
accent: orange
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
|
|
# https://squidfunk.github.io/mkdocs-material/reference/formatting/
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- footnotes
|
|
- md_in_html
|
|
- pymdownx.blocks.caption
|
|
- pymdownx.critic
|
|
- pymdownx.caret
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.tilde
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
|
|
plugins:
|
|
- search
|
|
- callouts
|
|
- mike
|
|
- glightbox:
|
|
touchNavigation: true
|
|
loop: false
|
|
effect: zoom
|
|
slide_effect: slide
|
|
width: 100%
|
|
height: auto
|
|
zoomable: true
|
|
draggable: true
|
|
skip_classes:
|
|
- custom-skip-class-name
|
|
auto_themed: true
|
|
auto_caption: false
|
|
caption_position: bottom
|
|
background: black
|
|
shadow: false
|
|
manual: false
|
|
- to-pdf:
|
|
cover: true
|
|
enabled_if_env: PDF_EXPORT
|
|
cover_logo: logo-plain.png
|
|
cover_subtitle: Immutable.Friendly.Secure
|
|
custom_template_path: doc/templates
|
|
output_path: pdf/infix-user-guide.pdf
|
|
toc_level: 2
|
|
ordered_chapter_level: 3
|
|
heading_shift: false
|
|
|
|
extra:
|
|
generator: false
|
|
homepage: https://www.kernelkit.org/
|
|
version:
|
|
provider: mike
|