/
mkdocs.yml
128 lines (126 loc) · 4.3 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
site_name: The Haskell Tool Stack
site_description: The Haskell Tool Stack
site_author: Stack contributors
repo_url: https://github.com/commercialhaskell/stack/
edit_uri: tree/stable/doc/
copyright: Copyright (c) 2015-2024, Stack contributors
docs_dir: doc
site_dir: _site
theme:
name: material
palette:
primary: 'deep purple'
accent: 'deep purple'
icon:
logo: material/language-haskell
extra_css:
- css/extra.css
extra_javascript:
- js/searchhack.js
# Read the Docs requires JQuery for its JavaScript code to inject the flyout
# menu. Material for MkDocs does not come with JQuery.
- 'https://code.jquery.com/jquery-3.6.1.min.js'
nav:
- Welcome!: README.md
- How to get & use Stack:
- General guidance:
- Install/upgrade: install_and_upgrade.md
- User's guide (introductory): GUIDE.md
- FAQ: faq.md
- Other resources: other_resources.md
- Reference (advanced):
- Introduction: GUIDE_advanced.md
- Environment variables: environment_variables.md
- Configuration (project and global): yaml_configuration.md
- Global flags and options: global_flags.md
- bench command: build_command.md
- build command: build_command.md
- clean command: clean_command.md
- config commands: config_command.md
- dot command: dot_command.md
- docker commands: docker_command.md
- eval command: eval_command.md
- exec command: exec_command.md
- ghc command: ghc_command.md
- ghci command: ghci.md
- haddock command: build_command.md
- hoogle command: hoogle_command.md
- hpc command: hpc_command.md
- ide command: ide_command.md
- init command: init_command.md
- install command: build_command.md
- list command: list_command.md
- ls command: ls_command.md
- new command: new_command.md
- path command: path_command.md
- purge command: purge_command.md
- query command: query_command.md
- repl command: ghci.md
- run command: run_command.md
- runghc command: runghc_command.md
- runhaskell command: runghc_command.md
- script command: script_command.md
- sdist command: sdist_command.md
- setup command: setup_command.md
- templates command: templates_command.md
- test command: build_command.md
- uninstall command: uninstall_command.md
- unpack command: unpack_command.md
- update command: update_command.md
- upgrade command: upgrade_command.md
- upload command: upload_command.md
- Specific topics:
- Stack root: stack_root.md
- Snapshot and package location: pantry.md
- Snapshot specification: custom_snapshot.md
- stack.yaml vs a Cabal file: stack_yaml_vs_cabal_package_file.md
- Script interpreter: scripts.md
- Docker integration: docker_integration.md
- Nix integration: nix_integration.md
- Non-standard project initialization: nonstandard_project_init.md
- Debugging: debugging.md
- Editor integration: editor_integration.md
- Stack and Visual Studio Code: Stack_and_VS_Code.md
- Developing on Windows: developing_on_windows.md
- Shell auto-completion: shell_autocompletion.md
- CI: CI.md
- Travis CI: travis_ci.md
- Azure CI: azure_ci.md
- Lock files: lock_files.md
- Stack work directories: stack_work.md
- How Stack works (advanced):
- Build overview: build_overview.md
- Stack's code (advanced):
- Contributors:
- Contributor's guide: CONTRIBUTING.md
- Dev Containers: dev_containers.md
- Maintainers:
- Releases: maintainers/releases.md
- Maintainer team process: maintainers/team_process.md
- Add GHC version: maintainers/ghc.md
- Docker images: maintainers/docker.md
- Upgrading MSYS2: maintainers/msys.md
- Upgrading 7-Zip: maintainers/7zip.md
- HaskellStack.org: maintainers/haskellstack.org.md
- Self-hosted runners: maintainers/self-hosted_runners.md
- Docker images: maintainers/docker_images.md
- Signing key: SIGNING_KEY.md
- Glossary: glossary.md
- Version history: ChangeLog.md
markdown_extensions:
- admonition
- attr_list
- footnotes
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: true