mirror of
https://github.com/troglobit/finit.git
synced 2026-10-02 05:52:48 +07:00
Joachim Wiberg
4596e27eb0
Both the Finit project and Infix use the same MkDocs Material setup, and in the latter the User Guide has picked up a lot of polish that never made it back here: a single sidebar with section indexes instead of tabs, footnote tooltips, more pymdownx markup, image zoom tuning, and no generator advert in the footer. Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
152 lines
3.8 KiB
YAML
152 lines
3.8 KiB
YAML
site_name: User's Guide
|
|
site_description: Fast Init for Linux Systems
|
|
site_url: http://finit-project.github.io
|
|
repo_url: https://github.com/finit-project/finit
|
|
repo_name: Finit Project
|
|
copyright: Copyright © 2008-2026 Joachim Wiberg
|
|
docs_dir: doc/
|
|
edit_uri: edit/master/doc/
|
|
extra_css:
|
|
- extra.css
|
|
|
|
exclude_docs: |
|
|
TODO.md
|
|
ChangeLog.md
|
|
|
|
nav:
|
|
- Getting Started:
|
|
- Introduction: index.md
|
|
- Features: features.md
|
|
- Quick Example: example.md
|
|
- Building: build.md
|
|
- Configuration:
|
|
- Overview: config/index.md
|
|
- Files & Layout: config/files.md
|
|
- Conditions: conditions.md
|
|
- Runlevels: config/runlevels.md
|
|
- One-shot Tasks: config/task-and-run.md
|
|
- Services:
|
|
- Syntax: config/services.md
|
|
- Options: config/service-opts.md
|
|
- Environment: config/service-env.md
|
|
- Synchronization: config/service-sync.md
|
|
- Wrapper Scripts: config/service-wrappers.md
|
|
- Run-parts Scripts: config/runparts.md
|
|
- TTY & Console: config/tty.md
|
|
- Environment Variables: config/env.md
|
|
- Logging: config/logging.md
|
|
- Cgroups: config/cgroups.md
|
|
- Capabilities: config/capabilities.md
|
|
- Templating: config/templating.md
|
|
- SysV Compatibility: config/sysv.md
|
|
- Rescue Mode: config/rescue.md
|
|
- Limitations: config/limitations.md
|
|
- Usage:
|
|
- Commands & Status: initctl.md
|
|
- Switch Root: switchroot.md
|
|
- Rebooting & Halting: commands.md
|
|
- Command Line Options: cmdline.md
|
|
- Managing Services: service.md
|
|
- Signals: signals.md
|
|
- Reference:
|
|
- Runlevels Overview: runlevels.md
|
|
- Runparts & rc.local: runparts.md
|
|
- Plugins: plugins.md
|
|
- Watchdog: watchdog.md
|
|
- keventd: keventd.md
|
|
- Service State Machine: state-machine.md
|
|
- Distributions: distro.md
|
|
- Requirements: requirements.md
|
|
|
|
theme:
|
|
logo: img/logo.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: black
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- footnotes
|
|
- 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.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.snippets
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
|
|
plugins:
|
|
- search
|
|
- callouts
|
|
- 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
|
|
|
|
extra:
|
|
generator: false
|
|
homepage: https://finit-project.github.io/
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/finit-project/finit
|
|
name: Finit on GitHub
|