Skip to content

Commit 0fe0103

Browse files
committed
Minor changes to online documentation
In light of addition of social cards
1 parent 832904d commit 0fe0103

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

doc/maintainers/haskellstack.org.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,16 @@ specifies a Python requirements file in `doc/requirements.txt`.
4747
## MkDocs
4848

4949
The `doc/requirements.txt` file pins the version of MkDocs. As at
50-
2 September 2021 it is set to:
50+
13 April 2025 it is set to:
5151

52-
mkdocs==1.3.1
52+
mkdocs==1.6.0
5353

5454
A configuration file, `mkdocs.yml` is included in the repository root directory.
5555
See https://www.mkdocs.org/user-guide/configuration/.
5656

5757
`site_dir: _site` specifies the directory where the output HTML and other files
5858
are created. This directory is added to the `.gitignore` file.
5959

60-
MkDocs 1.3.0 replaced the `pages:` key with the `nav:` key.
61-
6260
## Material for MkDocs
6361

6462
Stack moved from the default `readthedocs` theme to Material for MkDocs after
@@ -77,8 +75,16 @@ theme:
7775
palette:
7876
primary: 'deep purple'
7977
accent: 'deep purple'
80-
icon:
81-
logo: material/language-haskell
78+
logo: img/stack-logo-white.svg
79+
favicon: img/stack-favicon.svg
80+
features:
81+
- content.code.annotate
82+
- content.code.copy
83+
- content.code.select
84+
- content.tabs.link
85+
- navigation.indexes
86+
- navigation.tabs
87+
- navigation.top
8288
~~~
8389

8490
Read the Docs requires [JQuery](https://jquery.com/) for its JavaScript code to

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ nav:
9797
- Environment variables: configure/environment_variables.md
9898
- Configuration files:
9999
- configure/yaml/index.md
100-
- Project-specific: configure/yaml/project.md
101-
- Non-project specific: configure/yaml/non-project.md
100+
- Project-specific configuration: configure/yaml/project.md
101+
- Non-project specific configuration: configure/yaml/non-project.md
102102
- Global flags and options: configure/global_flags.md
103103
- Customisation scripts: configure/customisation_scripts.md
104104
- Topics:
@@ -145,7 +145,7 @@ nav:
145145
- FAQ: faq.md
146146
- Glossary: glossary.md
147147
- More:
148-
- Other resoruces: other_resources.md
148+
- Other resources: other_resources.md
149149
- Version history: ChangeLog.md
150150

151151
markdown_extensions:

0 commit comments

Comments
 (0)