Files
thgtoa/mkdocs.yml
T
nopeitsnothing 11510a863b fix(css): oops, flat ToC rendering
Adjusted a few ToC and navigation settings to fix flat rendering.
Also removed `toc.integrate`
Fixed margin-left
Altered changelog admonition types
Fixed admonition title rendering bug (overlap)

Signed-off-by: nopeitsnothing <no@anonymousplanet.net>
2026-07-12 03:39:18 -04:00

161 lines
4.3 KiB
YAML

site_name: The Hitchhiker's Guide
site_author: Anonymous Planet
site_description: "The comprehensive guide for online #anonymity and #opsec."
site_dir: "site"
docs_dir: "docs"
exclude_docs: |
includes/
site_url: "https://anonymousplanet.net/"
repo_url: "https://github.com/Anon-Planet/thgtoa"
repo_name: ""
#edit_uri: ""blob/main/docs/{path}?plain=1""
theme:
name: material
custom_dir: docs/overrides
locale: en
favicon: media/profile.png
icon:
logo: material/bird
repo: simple/github
font: false # all fonts self-hosted in docs/fonts/
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.tabs
- navigation.sections
- navigation.path
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
language: en
palette:
- scheme: slate
primary: hacker
accent: green
toggle:
icon: material/monitor-off
name: Printing Press
- scheme: default
primary: custom
accent: custom
toggle:
icon: material/monitor
name: Monitor
plugins:
- social: {}
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
# - meta: {}
# Soon this will all be minified (It's a personal WIP that I already have stashed in git)
extra_css:
- stylesheets/hacker.css
- stylesheets/hacker-extra.css
- stylesheets/going-dark.css
- stylesheets/toggle.css
- stylesheets/navigation.css
- stylesheets/footer.css
- stylesheets/accessibility.css
# print-light.css is NOT included here - it's only injected during PDF builds via build_guide_pdf.py
# extra_css:
# - stylesheets/hacker-core.css
# - stylesheets/components.css
# - stylesheets/accessibility.css
# - stylesheets/print-and-utilities.css
copyright: >-
&copy; 2023-2026 Anonymous Planet & contributors &mdash;
licensed under <a href="https://creativecommons.org/licenses/by-sa/4.0/" rel="license">CC BY-SA 4.0</a>.
extra:
social:
- icon: simple/mastodon
link: https://ioc.exchange/@unknown
name: Mastodon
- icon: simple/x
link: https://x.com/anonplanetorg
name: X
- icon: simple/gitlab
link: http://wmj5kiic7b6kjplpbvwadnht2nh2qnkbnqtcv3dyvpqtz7ssbssftxid.onion/
name: "0xacab"
- icon: simple/gitea
link: http://it7otdanqu7ktntxzm427cba6i53w6wlanlh23v5i3siqmos47pzhvyd.onion/anonypla
name: Darktea
- icon: simple/github
link: https://github.com/anon-planet
name: Github
- icon: simple/gitlab
link: https://gitlab.com/anonymousplanetorg
name: Gitlab
- icon: simple/codeberg
link: https://codeberg.org/anonymousplanet
name: Codeberg
- icon: simple/torbrowser
link: https://gitlab.torproject.org/anonymousplanet/the-hitchhikers-guide
name: Gitlab at Tor Project
# - icon: simple/torbrowser
# link: http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion/ (defunct)
# name: Hidden service
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.arithmatex:
generic: true
- footnotes
- pymdownx.details
- pymdownx.mark
- attr_list
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.critic: {}
- pymdownx.caret: {}
- pymdownx.keys: {}
- pymdownx.mark: {}
- pymdownx.tilde: {}
- abbr
- pymdownx.snippets:
base_path: ["docs"]
auto_append:
- includes/glossary.md
- pymdownx.tasklist:
custom_checkbox: true
- attr_list: {}
- def_list: {}
- md_in_html: {}
- meta: {}
- tables: {}
- footnotes: {}
- toc:
permalink: "λ"
toc_depth: 3
nav:
- "Home": index.md
- "Verify": verify/index.md
- "Guide": guide/index.md
- "Code": code/index.md
- "Donations": contribute/index.md
- "A Constitution": constitution/index.md
- "Mirrors": mirrors/index.md
- "Changelog": changelog/index.md
- "Anonymous Planet": about/index.md
- "PGP": pgp/index.md