570 Commits

Author SHA1 Message Date
Oleh Prypin
2062a11e7a Implement cache busting: append a suffix to CSS and JS URLs 2023-06-18 23:27:48 +02:00
Oleh Prypin
9394d4b168 Merge remote-tracking branch 'origin/master' into mjs 2023-06-18 19:18:22 +02:00
Oleh Prypin
9d56fa21d9 Merge remote-tracking branch 'origin/master' into ignore 2023-06-09 20:18:54 +02:00
Oleh Prypin
f2d14c52a7 Merge pull request #3205 from mkdocs/getdeps
New `get-deps` command: infer PyPI dependencies from mkdocs.yml
2023-06-09 20:05:07 +02:00
Oleh Prypin
4f98a94f14 Fix typo in extra_javascript doc 2023-06-08 10:33:48 +02:00
Timothée Mazzucotelli
18c01d2e74 Add plugin logger utility (#3245) 2023-06-07 01:22:00 +02:00
Timothée Mazzucotelli
45c8b9669b Add note about formatting code (#3244) 2023-06-07 00:43:45 +02:00
Oleh Prypin
3363c615de Update docs - "best-of-mkdocs" became "catalog" 2023-06-07 00:39:01 +02:00
Timothée Mazzucotelli
73c640f73e Hide instance-attribute labels in docs (#3238) 2023-06-04 18:43:18 +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
0f793b9984 Make TemplateContext typed, move utils.filters to utils.templates 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
d4d483c779 Print the local URL of pages that are "built only for the preview"
And refactor `LiveReloadServer` to not start listening in the constructor
2023-06-03 15:07:35 +02:00
Oleh Prypin
5af8bd3053 Infer titles of pages based on full Markdown parsing (#3191)
Properly parse Markdown and report the first H1 tag rather than naively looking for `# Stuff` at the start of the doc.

This satisfies feature requests such as supporting setext-style headers and fixes attr-list suffixes that failed to be ignored.

Co-authored-by: Hendrik Polczynski <hendrikpolczyn@gmail.com>
Co-authored-by: Darrick Herwehe <darrick@exitcodeone.com>
2023-05-29 21:59:31 +02:00
Oleh Prypin
930ae26a55 New flag mkdocs serve --clean - simulate a pure mkdocs build and then serve
Also rename `--dirtyreload` flag to `--dirty` (keep the old name working)
2023-05-29 01:04:29 +02:00
Oleh Prypin
f37ce51da1 Serve excluded files in mkdocs serve + new not_in_nav config
* Docs that match any of the `not_in_nav` patterns will not produce warnings about never being included into the nav.

* Files that are excluded by `exclude_docs` will now be preserved in the `Files` collection and will even be rendered but only in `mkdocs serve` mode - such files will have a `DRAFT` notice prepended to the content.
2023-05-29 01:04:29 +02:00
Oleh Prypin
67e0e4e052 New exclude_docs config: gitignore-like patterns of files to exclude
These files will not be picked up into the `Files` collection and as such, also the final built site.

Also adds the ability to *un*-ignore the files that MkDocs forcibly ignores.
2023-05-28 23:10:25 +02:00
Zac Knitter
2a232bf153 Update customizing-your-theme.md (#3215)
Fixed typo
2023-05-07 10:20:05 +02:00
Oleh Prypin
3d1b0113c2 Release 1.4.3 (#3208) 2023-05-02 23:16:34 +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
876995cdf3 Generalize tr_TR translations to just tr, explain how to decide this (#3195) 2023-04-27 19:16:19 +02:00
Ultrabug
e6189fde03 update links and messages to https (#3192)
* docs(guides): update links to use https with newer urls

* docs(gh_deploy): update user CNAME message to use https

---------

Co-authored-by: Oleh Prypin <oleh@pryp.in>
2023-04-24 11:44:49 +02:00
kiraware
1f1bfad763 Add Indonesian translations of themes (#3154) 2023-04-22 12:31:14 +02:00
Oleh Prypin
324f486adc Docs: fix broken links to pocoo.org 2023-04-21 22:24:36 +02:00
pcgaustad
30e9b6aaf4 Mention in the documentation that a fork of the repository is necessary for translating the included templates (#3026)
Co-authored-by: Ultrabug <ultrabug@users.noreply.github.com>
2023-04-21 22:19:49 +02:00
Steven Maude
49fbc35d11 Correct capitalisation of "GitHub Pages" (#3037)
To be consistent with GitHub's usage, and the use in MkDocs' documentation elsewhere.
2023-04-21 19:17:35 +02:00
Hélène Martin
0c1e9917a5 Align edit_url text and example (#3124) 2023-04-21 19:16:47 +02:00
Y.D.X
487e292dcc Docs: Fix indents in the example code (#3139) 2023-04-21 19:14:15 +02:00
HankB
56b235a8ad Docs: add warning about uncommitted changes (#3034) 2022-11-07 00:57:33 +01:00
Oleh Prypin
ec7eee6ce3 Release 1.4.2 (#3032) 2022-11-01 19:23:29 +01:00
pcgaustad
f190c35a99 Translate mkdocs theme to Norwegian (nb and nn) (#3024) 2022-10-29 14:55:02 +02:00
Oleh Prypin
faba3f046e Add missed entry in release notes 2022-10-15 21:29:03 +02:00
Oleh Prypin
aa9eabea1a Release 1.4.1 (#3004) 2022-10-15 21:13:41 +02:00
Oleh Prypin
b2083d07f5 Add CLI reference page, auto-generated from Click (#2996) 2022-10-08 11:17:05 +02:00
Oleh Prypin
aa10190a55 Migrate from Tox to Hatch as test runner (#2991) 2022-10-07 23:18:05 +02:00
Oleh Prypin
30cdac47a9 Switch to pyproject.toml and Hatch build (#2988) 2022-10-07 00:42:48 +02:00
Oleh Prypin
12ee265cc1 Remove pybabel setuptools integration (#2990) 2022-10-03 19:30:02 +02:00
Oleh Prypin
4dd64a6950 Mention event priority values also in release notes 2022-09-27 20:00:35 +02:00
Oleh Prypin
927ee2684b Release 1.4.0 (#2986) 2022-09-27 19:26:54 +02:00
Oleh Prypin
5015fa72af Add examples of class-based schema with ListOfItems 2022-09-26 11:35:24 +02:00
Oleh Prypin
a4c1bb14dc Add documentation for type-checked configs 2022-09-25 19:19:09 +02:00
Oleh Prypin
dce025e544 Remove duplicated style due to a merge mistake 2022-09-19 22:46:24 +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
8dfef829b8 Enable <details> admonitions and nested codeblocks 2022-09-19 22:22:12 +02:00
Oleh Prypin
b33fb2ac67 Update admonition styles in MkDocs theme: (#2981)
* Apply admonition styles also to <details> tags
* Increase contrast of default admonitions
* Add some admonition styles (only for use on MkDocs' site for now)
2022-09-19 22:19:04 +02:00
Oleh Prypin
2a8ed44d9e Hooks feature: run plugin events from local Python files (#2978) 2022-09-19 22:18:38 +02:00
Oleh Prypin
aa4e669c33 Add Ukrainian translations (#2980) 2022-09-19 21:52:05 +02:00
Alexander Krasnikov
b11bed87ab Add Russian localization (#2976)
Co-authored-by: Oleh Prypin <oleh@pryp.in>
2022-09-19 09:06:03 +02:00
Oleh Prypin
cf8a07475f Deduplicate the nav specification with literate-nav 2022-09-18 18:47:54 +02:00