nsyte/mkdocs.yml at main · sandwichfarm/nsyte · 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
site_name: nsyte
site_url: https://nsyte.run/docs/
site_description: Documentation for nsyte - publish your site to nostr and blossom servers
site_author: sandwichfarm
site_dir: ./dist/docs
use_directory_urls: true
repo_url: https://github.com/sandwichfarm/nsyte
repo_name: sandwichfarm/nsyte

theme:
  name: material
  font: false
  logo: assets/logo.svg
  favicon: assets/favicon.svg
  features:
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.suggest
    - navigation.instant
    - navigation.indexes
  custom_dir: docs/overrides
  palette:
    scheme: slate
    primary: green
    accent: green

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - footnotes
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.mark
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

nav:
  - Home: https://nsyte.run/
  - Documentation: index.md
  - Getting Started:
      - Installation: installation.md
      - Basic Usage: usage/index.md
  - Configuration: usage/configuration.md
  - Commands:
      - Overview: usage/commands.md
      - init: usage/commands/init.md
      - upload: usage/commands/upload.md
      - download: usage/commands/download.md
      - ls: usage/commands/ls.md
      - serve: usage/commands/serve.md
      - run: usage/commands/run.md
      - validate: usage/commands/validate.md
      - debug: usage/commands/debug.md
      - deploy: usage/commands/deploy.md
      - delete: usage/commands/delete.md
      - undeploy: usage/commands/undeploy.md
      - ci: usage/commands/ci.md
      - bunker: usage/commands/bunker.md
  - Guides:
      - Deployment: guides/deployment.md
      - Security:
          - Overview: guides/security.md
          - Platform Details: guides/security-platforms.md
          - Troubleshooting: guides/security-troubleshooting.md
      - CI/CD: guides/ci-cd.md
      - Local Setup: guides/local-setup.md
      - NIP-89 App Handler: nip89-handler.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/sandwichfarm/nsyte

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js