-
-
Notifications
You must be signed in to change notification settings - Fork 34
/
mkdocs.yml
416 lines (406 loc) · 17.1 KB
/
mkdocs.yml
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
---
# Practicalli Spacemacs
site_name: Practicalli Spacemacs
site_url: https://practical.li/spacemacs
site_description: Practical guide to Clojure development with Spacemacs
site_author: Practicalli
site_org: https://practical.li
copyright: Copyright © 2023 Practicali <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>
repo_url: https://github.com/practicalli/spacemacs/
edit_uri: https://github.com/practicalli/spacemacs/edit/main/docs/
# Deployment
# remote_name: origin
remote_branch: gh-pages # deployment branch
# Theme and styling
theme:
name: material
logo: assets/images/practicalli-logo.png
favicon: assets/favicon.svg
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tabs.link
- navigation.footer
- navigation.indexes # Nav sections can have files
- navigation.instant # Avoid page reloading for internal links
- navigation.top
- navigation.tracking # Update URL with anchor
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: purple
accent: deep purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: purple
toggle:
icon: material/brightness-4
name: Switch to light mode
# Override theme
custom_dir: overrides
extra_css:
- assets/stylesheets/extra.css
## Additional styling
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- attr_list
- md_in_html # Grids
- footnotes # footnotes and abbreviations
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
url_download: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.keys # keyboard keys
- pymdownx.magiclink
- def_list # lists
- pymdownx.tasklist:
custom_checkbox: true # checkboxes
- toc:
permalink: λ︎
## Plugins
plugins:
# Explicitly add search plugin when defining plugins in this configuration file
- search
- callouts
- glightbox # Image aligning
- git-revision-date-localized: # Update and Creation date of each page
# enable_creation_date: true
fallback_to_build_date: true
# Generate Social Cards via CI only
# in assets/images/social
- social:
cards: !ENV [MKDOCS_SOCIAL_CARDS_GENERATE, true]
# Redirect pages when moved or changed
# - redirects:
# redirect_maps:
# changelog/insiders.md: insiders/changelog.md
# reference/meta-tags.md: reference/index.md
# Footer / Social Media
extra:
analytics:
provider: google
property: G-YBK519HFM6
social:
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/jr0cket/
- icon: fontawesome/brands/slack
link: https://clojurians.slack.com/messages/practicalli
- icon: fontawesome/brands/twitter
link: https://twitter.com/practical_li
- icon: fontawesome/brands/github
link: https://github.com/practicalli
- icon: fontawesome/brands/docker
link: https://hub.docker.com/u/practicalli
# Navigation
nav:
- Introduction:
- index.md
- REPL Workflow: introduction/repl-workflow.md
- Why Spacemacs:
- introduction/why-spacemacs/index.md
- Extensive Languages: introduction/why-spacemacs/extensive-language-support.md
- Mneomic Menus: introduction/why-spacemacs/mnemonic-menu.md
- Multi-modal Editing: introduction/why-spacemacs/states.md
- Layer Configuration: introduction/why-spacemacs/layers.md
- Clojure Support: introduction/why-spacemacs/clojure-layer.md
- Structural Editing: introduction/why-spacemacs/structural-editing.md
- Selection Narrowing: introduction/why-spacemacs/helm.md
# - introduction/why-spacemacs/helm-transient-state.md # TODO: move content to helm.md
- introduction/why-spacemacs/project-file-navigation.md
- introduction/why-spacemacs/layouts.md
# - introduction/why-spacemacs/configuring-spacemacs.md
- Mini-cheatsheet: spacemacs-mini-cheatsheet.md
- Contributing: introduction/contributing.md
- Writing Tips: introduction/writing-tips.md
- Resources: introduction/additional-resources.md
- Pre-install: install-spacemacs/pre-install.md
- Install:
- install-spacemacs/index.md
- Manual Configuration: install-spacemacs/manual-configuration.md
- Clojure Layer: install-spacemacs/clojure-layer.md
- Enhance Clojure:
- install-spacemacs/enhance-clojure-experience/index.md
- Smartparens: install-spacemacs/enhance-clojure-experience/smartparens.md
- Evil Structural Editing: install-spacemacs/enhance-clojure-experience/evil-structural-editing.md
- Clj-kondo server: install-spacemacs/enhance-clojure-experience/clj-kondo-via-lsp.md
- Clojure LSP:
- install-spacemacs/clojure-lsp/index.md
- install-spacemacs/clojure-lsp/configure-lsp-and-cider.md
- install-spacemacs/clojure-lsp/snippets.md
- Font: install-spacemacs/change-font.md
- Full Screen: install-spacemacs/maximised-full-screen.md
- Themes: install-spacemacs/themes.md
- Line Numbers: install-spacemacs/line-numbers.md
- Start Emacs Instantly: install-spacemacs/emacsclient-server.md
- Git Editor: install-spacemacs/emacsclient-git-commit-messages.md
- Update Spacemacs: install-spacemacs/update.md
- Troubleshoot: install-spacemacs/troubleshooting.md
- Spacemacs Basics:
- spacemacs-basics/index.md
- spacemacs-basics/emacs-basics.md
- Projects:
- spacemacs-basics/working-with-projects/index.md
- spacemacs-basics/working-with-projects/dird.md
- spacemacs-basics/working-with-projects/layouts.md
- spacemacs-basics/working-with-projects/managing-buffers.md
- spacemacs-basics/working-with-projects/managing-windows.md
- spacemacs-basics/working-with-projects/open-and-create-files.md
- spacemacs-basics/working-with-projects/projectile.md
- spacemacs-basics/working-with-projects/ranger.md
- spacemacs-basics/working-with-projects/searching-projects.md
- spacemacs-basics/working-with-projects/tidying-up-buffers.md
- spacemacs-basics/working-with-projects/treemacs.md
- spacemacs-basics/visual-select.md
- spacemacs-basics/spell-checking.md
- Evil Basics:
- spacemacs-basics/evil/index.md
- spacemacs-basics/evil/editing-states.md
- spacemacs-basics/vim-style/key-binding-reference.md
- spacemacs-basics/vim-style/speaking-evil.md
- spacemacs-basics/vim-style/vim-quick-reference.md
- spacemacs-basics/vim-style/vim-tips-for-developers.md
- spacemacs-basics/evil-g-menu.md
- spacemacs-basics/evil-z-menu.md
- Evil Tools:
- spacemacs-basics/evil-tools/index.md
- spacemacs-basics/evil-tools/helm-swoop.md
- spacemacs-basics/evil-tools/iedit.md
- spacemacs-basics/evil-tools/iedit-in-action.md
- spacemacs-basics/evil-tools/narrowing.md
- spacemacs-basics/evil-tools/replacing-text-across-projects.md
- spacemacs-basics/evil-tools/multiple-cursors.md
- Clojure:
- clojure-development/index.md
- REPL:
- clojure-repl/index.md
- clojure-repl/connect-to-repl.md
- clojure-repl/connect-to-remote-repl.md
- clojure-repl/jack-in-to-repl.md
- clojure-repl/portal-data-visualization.md
- clojure-repl/clojurescript-repl.md
- Refresh REPL State: clojure-repl/refresh-repl-state.md
- clojure-repl/component-lifecycle.md
- clojure-repl/clear-repl-buffer.md
- Project Config:
- clojure-development/project-configuration/index.md
- Monorepo: clojure-development/project-configuration/monorepo-nested-projects.md
- Documentation:
- documentation/index.md
- Comments: documentation/comments.md
- Apropos: documentation/apropos.md
- Cider-doc: documentation/cider-doc.md
- Javadoc: documentation/javadoc.md
- Evaluate Clojure:
- evaluating-clojure/index.md
- Expressions: evaluating-clojure/expressions.md
- Inspect Values: evaluating-clojure/inspect.md
- Interrupt Eval: evaluating-clojure/interrupt.md
- Remove Eval: evaluating-clojure/undefine.md
- Intermediate values: evaluating-clojure/enlighten.md
- Macro Expand: evaluating-clojure/macro-expand.md
- evaluating-clojure/evaluate-in-repl-buffer.md
- Testing:
- testing/index.md
- testing/kaocha-test-runner.md
- testing/unit-testing/index.md
- testing/unit-testing/cider-test-deps-edn-projects.md
- testing/unit-testing/writing-unit-tests.md
- testing/unit-testing/running-tests.md
- testing/unit-testing/re-run-tests-from-test-report-buffer.md
- testing/unit-testing/refactor-unit-tests.md
- testing/unit-testing/configure-cider-test-runner.md
- Navigating Code:
- navigating-code/index.md
- Expressions: navigating-code/expressions.md
- Markers: navigating-code/markers.md
- Namespaces: navigating-code/namespaces.md
- Symbols: navigating-code/names-symbols.md
- Functions: navigating-code/function-definitions.md
- Java: navigating-code/java-definitions.md
- Code Folding: navigating-code/code-folding.md
- Find Uses: navigating-code/find-usages.md
- Structural Editing:
- structural-editing/index.md
- Smartparens: structural-editing/smartparens.md
- Evil Cleverparens: structural-editing/cleverparens.md
- Lisp State:
- structural-editing/lisp-state/index.md
- Wrap Unrap: structural-editing/lisp-state/wrap-unwrap.md
- Slurp Barf: structural-editing/lisp-state/slurp-barf.md
- Deleting: structural-editing/lisp-state/deleting.md
- Raising: structural-editing/lisp-state/raising.md
- Snippets:
- snippets/index.md
- Clojure LSP:
- snippets/clojure-lsp/index.md
- snippets/clojure-lsp/custom-snippets.md
- snippets/clojure-lsp/practicalli-snippets.md
- Yasnippets:
- snippets/yasnippets/index.md
- snippets/yasnippets/built-in-snippets.md
- snippets/yasnippets/clojure-snippets-reference.md
- snippets/yasnippets/create-snippets.md
- snippets/yasnippets/practicalli-snippets.md
- snippets/yasnippets/writing-snippets.md
- Refactor:
- refactor/index.md
- Function: refactor/functions.md
- Namespace: refactor/namespace.md
- Project: refactor/project.md
- Clojure Mode: refactor/clojure-mode.md
- Clojure LSP: refactor/clojure-lsp.md
- Debug:
- debug-clojure/index.md
- Understand Errors: debug-clojure/understanding-errors.md
- Format Errors: debug-clojure/format-error-messages.md
- Inspect values: debug-clojure/inspect-values.md
- Cider debug: debug-clojure/cider-debug.md
- Classpath Issues: debug-clojure/classpath-issues.md
- core-async: debug-clojure/core-async.md
- Sayid Debug: debug-clojure/sayid-debug.md
- Code Quality:
- improving-code/index.md
- improving-code/live-linting.md
- improving-code/batch-linting.md
- improving-code/idiomatic-code-checking.md
- improving-code/formatting.md
- Source Control:
- source-control/index.md
- Git Layer: source-control/configure-layers.md
- Git Config: source-control/git-configuration.md
- Forge Config: source-control/forge-configuration.md
- GitHub Clone: source-control/github-clone.md
- Magit Git Client:
- source-control/magit/index.md
- source-control/magit/create-local-repository.md
- source-control/magit/list-local-repositories.md
- source-control/magit/status.md
- source-control/magit/branching.md
- source-control/magit/staging-changes.md
- source-control/magit/stashing.md
- source-control/magit/commit-changes.md
- source-control/magit/tag-commit.md
- source-control/magit/timemachine.md
- source-control/magit/reset-commit-history.md
- source-control/magit/interactive-rebasing.md
- source-control/magit/cherry-picking.md
- source-control/magit/blame.md
- source-control/magit/clean-up-magit-sessions.md
- source-control/magit/version-highlighting.md
- Remote Repository:
- source-control/magit/remote-repositories/index.md
- source-control/magit/remote-repositories/add-remote.md
- source-control/magit/remote-repositories/checkout-remote-branch.md
- source-control/magit/remote-repositories/clone.md
- source-control/magit/remote-repositories/configure-default-push.md
- source-control/magit/remote-repositories/configure-default-upstream.md
- source-control/magit/remote-repositories/pull-changes.md
- source-control/magit/remote-repositories/push-changes.md
- source-control/magit/remote-repositories/try-pull-requests.md
- Magit Forge:
- source-control/magit/forge/index.md
- Add Repository to Database: source-control/magit/forge/add-repository-to-database.md
- Remote Fork: source-control/magit/forge/forks.md
- Manage Issues: source-control/magit/forge/issues.md
- Manage Pull Requests: source-control/magit/forge/pull-requests.md
- Markdown:
- markdown-mode/index.md
- Org-mode:
- org-mode/index.md
- org-mode/headings.md
- org-mode/lists-and-checkboxes.md
- org-mode/linking.md
- org-mode/todo-states.md
- org-mode/tables.md
- org-mode/code-blocks.md
- org-mode/org-mode-tweaks.md
- org-mode/org-journal.md
- org-mode/yasnippets.md
- org-mode/literate-programming/index.md
- Database:
- database-access/index.md
- database-access/add-sql-layer-and-lsp.md
- database-access/connection-configuration.md
- database-access/external-dependencies.md
- database-access/using-sql.md
- Ultra-Mobile Termux:
- termux/index.md
- F-Droid: termux/fdroid-install.md
- Termux Setup: termux/setup.md
- Using Termux: termux/using-termux.md
- Git: termux/git.md
- Zsh: termux/custom-shell.md
- Clojure: termux/clojure-development.md
- Spacemacs: termux/spacemacs.md
- Misc:
- misc/index.md
- misc/artist-mode.md
- misc/unicode-characters.md
- Reference:
- reference/index.md
- Switch to Spacemacs develop: reference/switch-to-develop.md
- reference/emacs-quick-reference.md
- reference/spacemacs-conventions.md
- reference/hydra-menus.md
- reference/projectile.md
- reference/cider/index.md
- reference/cider/configuration-variables.md
- Clojure REPL:
- external-repl/index.md
- external-repl/connect-to-running-repl.md
- external-repl/switching-to-repl.md
- external-repl/show-repl-on-connect.md
- external-repl/repl-command-menu.md
- external-repl/repl-history.md
- Clojure Standard Library:
- reference/clojure/index.md
- reference/clojure/control-flow.md
- reference/clojure/data-structures.md
- reference/clojure/functions.md
- reference/clojure/maths.md
- reference/clojure/strings.md
- Clojure LSP:
- reference/clojure-lsp/index.md
- LSP Variables: reference/clojure-lsp/lsp-variables-reference.md
- reference/structural-editing/smartparens-cheatsheet.md
- reference/keybindings/index.md
- reference/keybindings/cider-keybindings.md
- reference/keybindings/vim-keybindings.md
- reference/vim/getting-comfortable.md
- reference/vim/key-bindings.md
- os-specific-config/macosx.md
- Emacs:
- emacs-lisp/index.md
- Emacs Shell: emacs-lisp/eshell.md
- encryption/index.md
- encryption/create-gpg-key.md
- writing-emacs-lisp/index.md
- Alternative Tools:
- alternative-tooling/index.md
- alternative-tooling/leiningen.md
- alternative-tooling/org-easy-templates.md
- To Review:
- spacemacs-basics/vim-style/common-evil.md
- introduction/why-spacemacs/why-evil.md