BitNode-Console/mkdocs.yaml at main · IanTeda/BitNode-Console · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# mkdocs.yaml
#
# MkDocs site configuration for BitNode Console documentation.
#
# Local development:
#   pip install -r docs/requirements.txt
#   mkdocs serve          # live-reload preview at http://127.0.0.1:8000
#   mkdocs build          # build static site to site/
#
# Deployment (GitHub Pages):
#   mkdocs gh-deploy --force --clean
#   The .github/workflows/mkdocks.yaml workflow runs this automatically on
#   every push to main or develop.
#
# Reference: https://www.mkdocs.org/user-guide/configuration/

site_name: BitNode Console
site_url: https://ianteda.github.io/BitNode-Console
site_description: >-
  A web-based interface for managing a Bitcoin Knots/Core daemon node —
  configuration, status monitoring, and log viewing without CLI/SSH access.
site_author: Ian Teda
repo_url: https://github.com/IanTeda/bitnode-console
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2024 Ian Teda

theme:
  name: material
  palette:
    - scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.code.copy

nav:
  - Home: index.md
  - Configuration: configuration.md
  - Development:
      - Structure: structure.md
      - Product Requirements: product-requirements.md

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true