ilyagr.bsky.social
just playing with tangled
1site_name: !ENV [MKDOCS_SITE_NAME, 'Jujutsu docs']
2site_dir: 'rendered-docs'
3# Not having this (or viewing the site locally, or from any place other than the
4# site_url) leads to version switching failing to preserve the current path.
5site_url: 'https://jj-vcs.github.io/jj/'
6theme:
7 name: 'material'
8 language: 'en'
9 favicon: images/favicon-96x96.png
10 features:
11 # - navigation.top
12
13 # Respect the user's default settings and add a toggle for manually choosing
14 # automatic/light/dark palette.
15 # taken from https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#system-preference
16 palette:
17 - media: '(prefers-color-scheme)'
18 toggle:
19 icon: material/brightness-auto
20 name: Switch to system preference
21 - media: '(prefers-color-scheme: light)'
22 scheme: default
23 primary: !ENV [MKDOCS_PRIMARY_COLOR, 'indigo']
24 toggle:
25 icon: material/brightness-7
26 name: Switch to light mode
27 - media: '(prefers-color-scheme: dark)'
28 scheme: slate
29 primary: !ENV [MKDOCS_PRIMARY_COLOR, 'indigo']
30 toggle:
31 icon: material/brightness-4
32 name: Switch to dark mode
33
34extra:
35 version:
36 provider: mike
37 alias: true
38
39validation:
40 anchors: warn
41
42# IMPORTANT: any changes to plugins have to be duplicated in
43# `mkdocs-offline.yml`. See that file for more details.
44plugins:
45 - mike:
46 # Should help search engines point to latest docs
47 # instead of (often obsolete) v?.??.? docs.
48 # TODO: Arguably, this could be `prerelease` when building prerelease docs.
49 canonical_version: latest
50 - include-markdown # For the CLI reference
51 - search
52 - redirects:
53 redirect_maps:
54 branches.md: bookmarks.md
55
56# Not all of these may be necessary, especially since the material
57# theme substitutes for some of them
58markdown_extensions:
59 - toc:
60 permalink: true
61 - extra
62 - sane_lists
63 - admonition
64 - codehilite:
65 guess_lang: false
66 # Allows list items with several paragraphs to be indented two spaces instead
67 # of four (like GitHub markdown)
68 - mdx_truly_sane_lists:
69 # No, thanks, we'd like only somewhat sane lists :)
70 # With `truly_sane: true`, together with breakless lists, it often splits
71 # a single list in two.
72 truly_sane: false
73 # Fixes weird concatenation of list items that happens sometimes when
74 # there is not a paragraph break between them and one of them has
75 # multiple paragraphs.
76 - mdx_breakless_lists
77 - pymdownx.tabbed:
78 alternate_style: true
79 - pymdownx.superfences:
80 custom_fences:
81 - name: mermaid
82 class: mermaid
83 format: !!python/name:pymdownx.superfences.fence_code_format
84 - pymdownx.details
85 - pymdownx.snippets
86 - pymdownx.emoji:
87 emoji_index: !!python/name:material.extensions.emoji.twemoji
88 emoji_generator: !!python/name:material.extensions.emoji.to_svg
89
90nav: # This lists all the files that become part of the documentation
91 - Home: 'index.md'
92
93 - Getting started:
94 - Installation and setup: 'install-and-setup.md'
95 - Tutorial and bird's eye view: 'tutorial.md'
96 - Working with GitHub: 'github.md'
97 - Working on Windows: 'windows.md'
98
99 - FAQ: 'FAQ.md'
100
101 - CLI reference: 'cli-reference.md'
102
103 - Testimonials: 'testimonials.md'
104
105 - Community-built tools: 'community_tools.md'
106
107 - Concepts:
108 - Working copy: 'working-copy.md'
109 - Bookmarks: 'bookmarks.md'
110 - Conflicts: 'conflicts.md'
111 - Operation log: 'operation-log.md'
112 - Glossary: 'glossary.md'
113
114 - Configuration:
115 - Settings: 'config.md'
116 - Fileset language: 'filesets.md'
117 - Revset language: 'revsets.md'
118 - Templating language: 'templates.md'
119
120 - Comparisons:
121 - Git comparison: 'git-comparison.md'
122 - Git command table: 'git-command-table.md'
123 - Git compatibility: 'git-compatibility.md'
124 - Sapling comparison: 'sapling-comparison.md'
125 - Other related work: 'related-work.md'
126
127 - Technical details:
128 - Architecture: 'technical/architecture.md'
129 - Concurrency: 'technical/concurrency.md'
130 - Conflicts: 'technical/conflicts.md'
131
132 - Contributing:
133 - Guidelines and "How to...?": 'contributing.md'
134 - Code of conduct: 'code-of-conduct.md'
135 - Design docs: 'design_docs.md'
136 - Design doc blueprint: 'design_doc_blueprint.md'
137 - Releasing: 'releasing.md'
138 - Temporary voting for governance: 'governance/temporary-voting.md'
139 - Governance: 'governance/GOVERNANCE.md'
140
141 - Design docs:
142 - git-submodules: 'design/git-submodules.md'
143 - git-submodule-storage: 'design/git-submodule-storage.md'
144 - JJ run: 'design/run.md'
145 - Sparse patterns v2: 'design/sparse-v2.md'
146 - Tracking branches: 'design/tracking-branches.md'
147 - Copy tracking and tracing: 'design/copy-tracking.md'
148
149 - Development roadmap: 'roadmap.md'
150
151# The following follow .gitignore syntax, relative
152# to the docs dir.
153not_in_nav: |
154 /paid_contributors.md