@@ -122,9 +122,11 @@ extensions.
122122
123123Those files are rendered on [ haskellstack.org] ( http://haskellstack.org ) by
124124[ Read the Docs] ( https://readthedocs.org/ ) using
125- [ MkDocs] ( https://www.mkdocs.org/ ) . The ` stable ` branch of the repository
126- provides the 'stable' version of the online documentation. The ` master ` branch
127- provides the 'latest' version of the documentation.
125+ [ MkDocs] ( https://www.mkdocs.org/ ) and the
126+ [ Material for MkDocs] ( https://squidfunk.github.io/mkdocs-material/ ) theme. The
127+ ` stable ` branch of the repository provides the 'stable' version of the online
128+ documentation. The ` master ` branch provides the 'latest' version of the
129+ documentation.
128130
129131The 'stable' version of the online documentation is intended to be applicable to
130132the latest released version of Stack. If you would like to help with that
@@ -138,13 +140,22 @@ from the content of files at the point in the responsitory's history specified
138140by the corresponding release tag. Consequently, that content is fixed once
139141released.
140142
141- The Markdown syntax supported by MkDocs can differ from the GitHub Flavored
142- Markdown ([ GFM] ( https://github.github.com/gfm/ ) ) supported for content on
143- GitHub.com. Please refer to the
143+ The Markdown syntax supported by MkDocs and the Material for MkDocs theme can
144+ differ from the GitHub Flavored Markdown ([ GFM] ( https://github.github.com/gfm/ ) )
145+ supported for content on GitHub.com. Please refer to the
144146[ MkDocs documentation] ( https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown )
147+ and the
148+ [ Material for MkDocs reference] ( https://squidfunk.github.io/mkdocs-material/reference/ )
145149to ensure your pull request will achieve the desired rendering.
146150
147- The configuration file for MkDocs is ` mkdocs.yml ` .
151+ The configuration file for MkDocs is ` mkdocs.yml ` . The extensions to the basic
152+ Markdown syntax used include:
153+
154+ * admonitions
155+ * code blocks, with syntax highlighting provided by
156+ [ Pygments] ( https://pygments.org/ )
157+ * content tabs, which can be nested
158+ * icons and emojis
148159
149160The files in the ` doc ` directory of the repository include two symbolic links
150161(symlinks), ` ChangeLog.md ` and ` CONTRIBUTING.md ` . Users of Git on Windows should
0 commit comments