centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity
2,019 Commits 21 Branches 61 Tags
pybabel
Commit Graph

59 Commits

Author SHA1 Message Date
Oleh Prypin
e22cfafd42 Run pybabel through Hatch as the command runner 
Replacement for 12ee265cc1
 2023-12-10 16:28:50 +01:00
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
7c3c3981b8 Docs: fix or drop broken anchor links 2023-11-11 14:28:14 +01:00
Oleh Prypin
dc45916aa1 Allow adding event handlers at multiple priorities (#3448) 
-within one plugin.
 2023-11-08 18:33:38 +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
efe5bfbc47 Merge pull request #3258 from mkdocs/dirtag 
Add YAML placeholder tags that resolve to current paths
 2023-07-01 15:42:29 +02:00
Oleh Prypin
25f4ea1533 Docs: small fixes 2023-06-30 00:34:22 +02:00
Oleh Prypin
99a9a90553 Document the !relative tag 2023-06-25 23:11:55 +02:00
Oleh Prypin
b162c5e824 Docs: automatically generate the list of locales (#3272) 2023-06-23 09:35:26 +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
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
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
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
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
Y.D.X
487e292dcc Docs: Fix indents in the example code (#3139) 2023-04-21 19:14:15 +02:00
Oleh Prypin
12ee265cc1 Remove pybabel setuptools integration (#2990) 2022-10-03 19:30:02 +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
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
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
cf8a07475f Deduplicate the nav specification with literate-nav 2022-09-18 18:47:54 +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
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