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
90# This lists all the files that become part of the documentation
91nav:
92- 'Home': 'index.md'
93
94- 'Getting started':
95 - 'Installation and Setup': 'install-and-setup.md'
96 - 'Tutorial and Birds-Eye View': 'tutorial.md'
97 - 'Working with GitHub': 'github.md'
98 - 'Working on Windows': 'windows.md'
99
100- FAQ: 'FAQ.md'
101
102- "CLI Reference": 'cli-reference.md'
103
104- Testimonials: 'testimonials.md'
105
106- "Community-built tools": 'community_tools.md'
107
108- Concepts:
109 - 'Working Copy': 'working-copy.md'
110 - 'Bookmarks': 'bookmarks.md'
111 - 'Conflicts': 'conflicts.md'
112 - 'Operation Log': 'operation-log.md'
113 - 'Glossary': 'glossary.md'
114
115- 'Configuration':
116 - 'Settings': 'config.md'
117 - 'Fileset language': 'filesets.md'
118 - 'Revset language': 'revsets.md'
119 - 'Templating language': 'templates.md'
120
121- 'Comparisons':
122 - 'Git comparison': 'git-comparison.md'
123 - 'Git command table': 'git-command-table.md'
124 - 'Git compatibility': 'git-compatibility.md'
125 - 'Sapling': 'sapling-comparison.md'
126 - 'Other related work': 'related-work.md'
127
128- 'Technical details':
129 - 'Architecture': 'technical/architecture.md'
130 - 'Concurrency': 'technical/concurrency.md'
131 - 'Conflicts': 'technical/conflicts.md'
132
133- Contributing:
134 - 'Guidelines and "How to...?"': 'contributing.md'
135 - 'Code of conduct': 'code-of-conduct.md'
136 - 'Design Docs': 'design_docs.md'
137 - 'Design Doc Blueprint': 'design_doc_blueprint.md'
138 - 'Releasing': 'releasing.md'
139 - 'Temporary Voting for Governance': 'governance/temporary-voting.md'
140 - 'Governance': 'governance/GOVERNANCE.md'
141
142- 'Design docs':
143 - 'git-submodules': 'design/git-submodules.md'
144 - 'git-submodule-storage': 'design/git-submodule-storage.md'
145 - 'JJ run': 'design/run.md'
146 - 'Sparse Patterns v2': 'design/sparse-v2.md'
147 - 'Tracking branches': 'design/tracking-branches.md'
148 - 'Copy tracking and tracing': 'design/copy-tracking.md'
149
150- 'Development Roadmap': "roadmap.md"
151
152# The following follow .gitignore syntax, relative
153# to the docs dir.
154not_in_nav: |
155 /paid_contributors.md