fuckingnode.github.io/mkdocs.yml at main · FuckingNode/fuckingnode.github.io · 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
site_name: FuckingNode
site_description: The fucking chaos of maintaining JavaScript projects ends here.
site_url: https://fuckingnode.github.io/
site_author: ZakaHaceCosas
copyright: Copyright &copy; 2024 - 2025 ZakaHaceCosas

repo_name: FuckingNode/FuckingNode
repo_url: https://github.com/FuckingNode/FuckingNode/

docs_dir: "docs"

nav:
    - Home: "index.html"

    - "Why FuckingNode?": "about/why.md"

    - "Installation & User manual":
          - User manual: "manual/index.md"
          - Installation: "manual/install.md"
          - Configuration: "manual/configuration.md"
          - Main usage guide: "manual/usage.md"
          - Individual project configuration: "manual/fknode-yaml.md"
          - Feature - Kickstart: "manual/kickstart.md"
          - Feature - Commit: "manual/commit.md"
          - Feature - Uncommit: "manual/uncommit.md"
          - Feature - Build: "manual/build.md"
          - Feature - Release: "manual/release.md"
          - Feature - Launch: "manual/launch.md"
          - Feature - Migrate: "manual/migrate.md"
          - Feature - Setup: "manual/setup.md"
          - Feature - Stats: "manual/stats.md"
          - Feature - Surrender: "manual/surrender.md"
          - Feature - Terminate: "manual/terminate.md"
          - Feature - Audit: "manual/audit.md"
          - "What's next?": "manual/whats-next.md"

    - Learn:
          - Learn: "learn/index.md"
          - Cross-runtime support: "learn/cross-runtime-support.md"
          - Error codes: "learn/errors.md"
          - System notifications: "learn/notifications.md"
          - How cleanup works under the hood: "learn/clean.md"
          - How audit works under the hood: "learn/audit.md"

    - Roadmap: "about/roadmap.md"
    - Brand guidelines: "about/branding.md"
    - Community: "about/social.md"
    - Donate: "https://buymeacoffee.com/zakahacecosas"

theme:
    name: material
    custom_dir: docs/overrides

    logo: fkn_logo_dark.webp
    favicon: fkn_icon.webp

    features:
        - navigation.path
        - navigation.tabs
        - navigation.sections
        - navigation.top
        - navigation.tracking
        - toc.follow
        - toc.integrate
        - navigation.expand
        - content.code.copy
        - navigation.footer

    palette:
        - scheme: slate
          primary: red
          accent: red

extra_css:
    - overrides/extra.css

extra_javascript:
    - js/math.js
    - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra:
    social:
        - icon: fontawesome/brands/youtube
          link: https://youtube.com/watch?v=J675ZcYBrHM
          name: See us on YouTube!
        - icon: fontawesome/brands/twitter
          link: https://x.com/FuckingNode
          name: Read us on Twitter
        - icon: fontawesome/brands/bluesky
          link: https://bsky.app/profile/fknode.bsky.social
          name: Read us on Bluesky
        - icon: fontawesome/brands/discord
          link: https://discord.gg/AA2jYAFNmq
          name: Chat us on Discord
        # - icon: fontawesome/solid/heart
          # link: "/about/donate/"
          # name: Donate to help maintaining this project
    analytics:
        provider: custom

plugins:
    - social
    - redirects:
          redirect_maps:
              "about.md": "about/roadmap.md"
              # "donate.md": "about/donate.md"
              "roadmap.md": "about/roadmap.md"
              "repo.md": "https://github.com/FuckingNode/FuckingNode"
              "repository.md": "https://github.com/FuckingNode/FuckingNode"
              "github.md": "https://github.com/FuckingNode/FuckingNode"
              "cross-runtime.md": "learn/cross-runtime-support.md"
              "cross-platform.md": "learn/cross-runtime-support.md"
              "crossruntime.md": "learn/cross-runtime-support.md"
              "crossplatform.md": "learn/cross-runtime-support.md"
              "follow-us.md": "about/social.md"
              "socials.md": "about/social.md"
              "why.md": "about/why.md"
              "motivation.md": "about/why.md"
              "install.md": "manual/install.md"
              "installation.md": "manual/install.md"
              "download.md": "manual/install.md"

markdown_extensions:
    - abbr
    - admonition
    - attr_list
    - def_list
    - footnotes
    - md_in_html
    - toc:
          permalink: true
    - pymdownx.arithmatex:
          generic: true
    - pymdownx.betterem:
          smart_enable: all
    - pymdownx.caret
    - pymdownx.details
    - pymdownx.highlight:
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
    - pymdownx.inlinehilite
    - pymdownx.keys
    - pymdownx.magiclink:
          normalize_issue_symbols: true
          repo_url_shorthand: true
          user: squidfunk
          repo: mkdocs-material
    - pymdownx.mark
    - pymdownx.smartsymbols
    - pymdownx.snippets
    - pymdownx.superfences:
          custom_fences:
              - name: mermaid
                class: mermaid
                format: !!python/name:pymdownx.superfences.fence_code_format
    - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - pymdownx.tasklist:
          custom_checkbox: true
    - pymdownx.blocks.caption