Commit Graph

520 Commits

Author SHA1 Message Date
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
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
Tim Gates
a1a2da72e9 Fix a few typos in docs (#2897)
There are small typos in:
- docs/user-guide/writing-your-docs.md
- mkdocs/contrib/search/templates/search/lunr.js
- mkdocs/utils/meta.py

Fixes:
- Should read `delimiters` rather than `deliminators`.
- Should read `environments` rather than `enviroments`
2022-08-03 18:54:09 +02:00
Oleh Prypin
a17a25c60e Release 1.3.1 (#2895) 2022-07-19 09:23:14 +02:00
Simon Li
03b48936e3 Docs: site_url is optional (#2863) 2022-07-18 23:49:23 +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
Fullchee Zhang
c32fbe3376 Fix typo in configuration.md (#2844) 2022-05-18 00:20:24 +02:00
Oleh Prypin
d2e2a2318d Release 1.3.0 (#2806) 2022-03-26 20:51:15 +01:00
Oleh Prypin
2016004b7e Merge branch 'release/1.2' 2022-03-26 20:37:41 +01:00
Oleh Prypin
6c1eb589f4 Release 1.2.4 (#2805) 2022-03-26 20:33:54 +01:00
Peyman M
09a5cd0dee Add Persian (fa) translation to the default themes (#2787) 2022-03-26 10:51:28 +01: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
Nick Schonning
234fb10e54 Docs: fix relative link (#2756) 2022-01-28 00:51:23 +01:00
Marc
912978c4e2 Provide german locale file for readthedocs theme (#2633) 2021-11-16 22:07:44 +01:00
steven-terrana
82fcf3115a Support custom directories to watch when running mkdocs serve (#2642)
* adds a `watch` property to the `mkdocs.yaml` schema. Accepts a list of directories to watch.
* adds a `-w`/`--watch` command line option to `mkdocs serve` that can be passed multiple times
* options from `mkdocs.yaml` and CLI flags are combined
* the livereload server will also print the directories that it watches
* docs updated

Co-authored-by: Oleh Prypin <oleh@pryp.in>
2021-11-07 10:29:58 +01:00
Kyle McNally
fa52d3ae71 Upgrade readthedocs theme to v1.0.0 (#2585)
Includes all upgrades 0.4.1->0.4.2->0.4.3->0.5.0rc->0.5.0rc2->0.5.0->0.5.1->1.0.0rc1->1.0.0

* Add the ability to use a logo in place of site_name in base.html
* New option `anonymize_ip`
* Drop Modernizr.js
* Upgrade jQuery (to 3.6.0) and others
2021-11-07 10:24:30 +01:00
Quentin Fortier
7106d7d245 Remove duplicated sentences in docs/deploying (#2667) 2021-11-07 10:11:30 +01:00
Oleh Prypin
7210ff7e2e Add latest members of MkDocs maintenance team (#2661) 2021-11-05 17:27:24 +01:00
Ashwin Ramaswami
aa97582400 Fix typo (#2663)
fazing -> phasing
2021-11-04 20:42:08 +01:00
François Capon
4aead07424 Fix typo mkdocs-theme.yml (mkdocs_theme.yml) (#2654) 2021-11-01 23:31:04 +01:00
Oleh Prypin
9880767940 Remove line length limit from Markdown documents (#2626)
Also try it out on some part of one document.
2021-10-26 20:40:25 +02:00
Álvaro Mondéjar
b4fd3411f2 Fix mistake in docs about nav configuration (#2636) 2021-10-26 20:40:04 +02:00
Oleh Prypin
d167eab473 Release 1.2.3 (#2614) 2021-10-12 23:27:41 +02:00
Álvaro Mondéjar
8345850060 Add hint about -f/--config-file in configuration documentation (#2616) 2021-10-12 22:10:48 +02:00
Andre Piantino
815af480d6 Added translation for Brazilian Portuguese (#2535)
* Added pt message translation file

* added  pt translations

* adjust pt_BR translation

* Added pt message translation file

* added  pt translations

* adjust pt_BR translation

* adjust to underscores

* Added pt message translation file

* added  pt translations

* adjust pt_BR translation

* Added pt message translation file

* added  pt translations

* adjust pt_BR translation

* adjust to underscores

Co-authored-by: nibuitoni <nicole.buitoni@rdstation.com>
2021-10-11 21:51:49 +02:00
Oleh Prypin
6563439956 Update contact instructions: announce chat, preference for issues (#2610)
* Update contact instructions: announce chat, preference for issues

* Fix mistake in sentence
2021-10-11 21:48:47 +02:00
Oleh Prypin
6b72eef748 We can again announce support of zh_CN locale (#2609)
This reverts commit 1c72c12472.
2021-10-11 19:20:27 +02:00
ChrisLasar
17a48105e1 Fix theme related links in first box on starting page (#2603) 2021-10-10 11:09:44 +02:00
Jules Topart
0d8fc8b922 user guide: correct word repetition (#2567) 2021-09-10 18:08:02 +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
Goto Hayato
519d2d32c3 Add Japanese (ja) translation for built-in themes (#2525) 2021-09-07 22:30:18 +02:00
Kuba Andrýsek
98b1d0e991 Fix Jinja Environment link (#2552) 2021-08-23 18:25:22 +02:00
Álvaro Mondéjar
4d1d1c1ba5 Fix various typos using codespell (#2549) 2021-08-20 17:06:01 +02:00
Álvaro Mondéjar
ea0ac7a07a Update contribution guide links (#2548) 2021-08-20 12:30:26 +02:00