28 Commits

Author SHA1 Message Date
Oleh Prypin
7c3c3981b8 Docs: fix or drop broken anchor links 2023-11-11 14:28:14 +01:00
Vedran Miletić
0bf4963090 Quote pip arguments containing square brackets (#3456)
This is strictly necessary when using non-bash shells (e.g. tcsh).
2023-11-01 17:20:14 +01:00
Oleh Prypin
8353493606 Use YAML indentation width of 2 spaces (#3287) 2023-07-09 15:59:51 +02:00
Oleh Prypin
ce826e94cc Merge pull request #3268 from mkdocs/conft
More precise types; support stdin as the `--config-file`
2023-06-19 22:22:10 +02:00
Oleh Prypin
9394d4b168 Merge remote-tracking branch 'origin/master' into mjs 2023-06-18 19:18:22 +02:00
Oleh Prypin
8b0971c4fe Use type-safe wrappers around run_event 2023-06-18 19:09:59 +02:00
Oleh Prypin
01be507e30 Define a base class for all navigation item classes 2023-06-18 18:03:03 +02:00
Oleh Prypin
3363c615de Update docs - "best-of-mkdocs" became "catalog" 2023-06-07 00:39:01 +02:00
Oleh Prypin
32d8c3a986 Expand config.extra_javascript to support type, async, defer
The top-level template object `extra_javascript` gets soft-deprecated because it still reports only a list of plain strings.

Themes need to take action and pick up the new config keys from `config.extra_javascript` instead.
2023-06-04 00:37:41 +02:00
Oleh Prypin
e254d4b1bc Consistently use tojson for pasting strings to JavaScript 2023-06-03 21:12:11 +02:00
Oleh Prypin
4ac1484de3 Link to Best-of-MkDocs instead of Plugins wiki in docs (#3207)
https://github.com/mkdocs/best-of-mkdocs
2023-05-02 22:42:16 +02:00
Oleh Prypin
324f486adc Docs: fix broken links to pocoo.org 2023-04-21 22:24:36 +02:00
Oleh Prypin
12ee265cc1 Remove pybabel setuptools integration (#2990) 2022-10-03 19:30:02 +02:00
Oleh Prypin
81d6ebf59d Replace instances of ```no-highlight 2022-09-19 22:22:33 +02:00
Oleh Prypin
6123328cbe Enforce fenced codeblocks in our docs 2022-09-19 22:22:33 +02:00
Oleh Prypin
9c0a8e50b1 Move some documentation into code, add misc API docs page (#2934) 2022-08-17 18:07:10 +02:00
Oleh Prypin
6f3801cbd3 Lint: align the whole list item into 4 spaces, don't disregard 1st line (#2915)
In other cases, drop the multiline way of writing the list
2022-08-07 14:57:06 +02:00
Oleh Prypin
cd1135ee3e Fix remaining markdownlint issues, partly by replacing definition lists (#2914) 2022-08-07 14:46:10 +02:00
Oleh Prypin
22af92c874 Migrate docs from "admonition" to "callouts" extension (#2684)
The result is exactly equivalent, just different syntax -- one that doesn't look weird in vanilla Markdown parsers such as on GitHub.
The output HTML before/after is equivalent , other than adding `<p class="admonition-title">Block</p>` in two cases, which I hid with CSS.

This also contributes to fixing the currently-present markdownlint MD053 violations, as it can't scan inside admonitions.

Add 'markdown-callouts' to dependencies and bump Markdown dep.
2022-08-06 17:35:36 +02:00
Sean
82bd8ba5ff Clean up code style (#2825)
* Change Github to GitHub
* Add space before closing tag
* Convert tabs to spaces
* Fix coding style for some css
2022-05-18 00:22:08 +02:00
Ultrabug
7841f2e8a7 dev-guide: document page.file (#2763) 2022-03-25 19:46:11 +01:00
Álvaro Mondéjar
f725e225ad Fix documentation error in Developing Themes (#2781) 2022-03-02 12:22:01 +01:00
François Capon
4aead07424 Fix typo mkdocs-theme.yml (mkdocs_theme.yml) (#2654) 2021-11-01 23:31:04 +01:00
Álvaro Mondéjar
98cc11a7de Fix minor errors in documentation (#2515) 2021-07-28 14:11:46 +02:00
Oleh Prypin
b12804d97e Fix some spelling typos (#2489) 2021-07-13 19:07:59 +02:00
Ultrabug
e1b77ab66e Support theme localization
A framework for translating themes as been added, which includes:

1. Use of Jinja's `i18n` plugin for translating phrases in templates (not page content).
2. A French translation of the built-in themes (contributions in other languages are welcome).
3. A new `theme.locale` option to define the locale/language of the site.
4. The search plugin uses the value of `theme.locale` as its default 'lang'.
5. Third party themes may chose to use the framework (use is optional).
6. A documented workflow for translating MkDocs built-in themes.
7. Custom tooling for use by translators and theme devs.

The dependencies are not installed by default and are not needed to use MkDocs without translations. However, for anyone who wants to make use of the features, `pip install mkdocs[i18n]` will install all necessary dependencies.

Relates to #211.
2021-05-06 14:30:21 -04:00
Waylan Limberg
6218e524b5 Correct docs if page template context var
Fixes #1736.
2021-04-10 19:31:14 -04:00
Waylan Limberg
a118183f5e Refactor docs (#2344)
The homepage has been redesigned. The "Installation" and "Getting Started" sections were moved to their own respective pages. Then, the homepage was restyled so that the list of features appear as a grid of cards.

The developer specific pages were moved to a new section: `dev-guide`. Any old URLs redirect to the new ones.
2021-04-04 16:14:29 -04:00