Commit Graph

31 Commits

Author SHA1 Message Date
Oleh Prypin
1910381516 Merge pull request #3463 from mkdocs/anch
Implement validation of anchors in links to other pages
2023-12-09 18:08:16 +01:00
Oleh Prypin
9ff9bb10bf Docs: warn about installing third-party plugins 2023-11-11 16:50:48 +01:00
Oleh Prypin
3f7c5ca129 Update docs about logging in plugins 2023-11-11 16:07:25 +01:00
Oleh Prypin
dc45916aa1 Allow adding event handlers at multiple priorities (#3448)
-within one plugin.
2023-11-08 18:33:38 +01:00
Oleh Prypin
8353493606 Use YAML indentation width of 2 spaces (#3287) 2023-07-09 15:59:51 +02:00
Oleh Prypin
99a9a90553 Document the !relative tag 2023-06-25 23:11:55 +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
Timothée Mazzucotelli
18c01d2e74 Add plugin logger utility (#3245) 2023-06-07 01:22:00 +02:00
Oleh Prypin
3363c615de Update docs - "best-of-mkdocs" became "catalog" 2023-06-07 00:39:01 +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
Y.D.X
487e292dcc Docs: Fix indents in the example code (#3139) 2023-04-21 19:14:15 +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
6123328cbe Enforce fenced codeblocks in our docs 2022-09-19 22:22:33 +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
00a71ba0be Move more documentation from Markdown into docstrings 2022-09-18 16:39:20 +02:00
Oleh Prypin
8315ece4f6 Consistently separate followup kwargs in plugin events 2022-09-14 18:59:26 +02:00
Oleh Prypin
8c3ea5fd12 Merge pull request #2972 from mkdocs/onshut
Add plugin events that persist across builds in `mkdocs serve`
2022-09-14 18:55:08 +02:00
Oleh Prypin
62d8a6f44d Let plugins choose the priority order of their events (#2973)
Add a decorator that sets a priority value for plugins' events. Events with higher priority are called first. Events without a chosen priority get a default of 0. Events that have the same priority are ordered as they appear in the config.
2022-09-14 17:33:06 +02:00
Oleh Prypin
a56ac6e051 Add plugin events that persist across builds in mkdocs serve
"One-time events" `on_startup(command)`, `on_shutdown`.

Their presence also shows that a plugin *wants* to persist across builds. Otherwise they will be re-created, to not change any existing behavior.
2022-09-11 23:06:34 +02:00
Oleh Prypin
901f6ffa1d Fixup for API docs: these toc entries were not intended 2022-08-21 19:44:53 +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
f79b34d174 Move plugin events docs into source code + refactor
* Create real (no-op) methods for each event in the base class.
* Refactor event dispatcher to not check for methods' existence, instead just call them.
* Move documentation from Markdown into docstrings of these methods.
* Activate the 'mkdocstrings' plugin.
* Use 'mkdocstrings' to insert documentation from those docstrings into the site.
2022-08-14 18:33:36 +02:00
Oleh Prypin
f5777a915a Docs: add a diagram with relations between all the plugin events (#2387) 2022-08-07 15:05:44 +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
Ultrabug
ba7f63ac81 dev guide: remove misleading usage of 'entry_point' wording (#2563)
closes mkdocs/mkdocs#2558 thx to @hwittenborn
2021-09-08 08:48:47 +02:00
Kuba Andrýsek
98b1d0e991 Fix Jinja Environment link (#2552) 2021-08-23 18:25:22 +02:00
Oleh Prypin
b12804d97e Fix some spelling typos (#2489) 2021-07-13 19:07:59 +02:00
Waylan Limberg
769a926691 Correct documentation of on_pre_template event.
The behavior of this event has never changed. The documentation was simply
incorrect. Fixes #2308.
2021-06-02 13:01:21 -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