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
1,858 Commits 21 Branches 61 Tags
67e0e4e052086bfcfd68d839104563fdc33bd8d0
Commit Graph

554 Commits

Author SHA1 Message Date
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
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
e44134797b on_startup: also pass a boolean dirty to detect --dirtyreload 2022-09-11 23:06:34 +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
4d4ef4c8f7 Add docs and tests for edit_uri_template option 2022-09-10 13:41:55 +02:00
Oleh Prypin
901f6ffa1d Fixup for API docs: these toc entries were not intended 2022-08-21 19:44:53 +02:00
mss1451
6897d1d4fa Add Turkish (Turkey) language support to themes (#2946) 2022-08-21 19:37:32 +02:00
Oleh Prypin
edb646621c Fix event name typo in diagram 2022-08-21 17:12:35 +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
12841f1aa5 Add type annotations for plugin events, include them in the docs 2022-08-14 18:33:36 +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