Commit Graph

256 Commits

Author SHA1 Message Date
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
Zac Knitter
2a232bf153 Update customizing-your-theme.md (#3215)
Fixed typo
2023-05-07 10:20:05 +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
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
HankB
56b235a8ad Docs: add warning about uncommitted changes (#3034) 2022-11-07 00:57:33 +01:00
pcgaustad
f190c35a99 Translate mkdocs theme to Norwegian (nb and nn) (#3024) 2022-10-29 14:55:02 +02:00
Oleh Prypin
b2083d07f5 Add CLI reference page, auto-generated from Click (#2996) 2022-10-08 11:17:05 +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
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
4d4ef4c8f7 Add docs and tests for edit_uri_template option 2022-09-10 13:41:55 +02:00
mss1451
6897d1d4fa Add Turkish (Turkey) language support to themes (#2946) 2022-08-21 19:37:32 +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
Fullchee Zhang
c32fbe3376 Fix typo in configuration.md (#2844) 2022-05-18 00:20:24 +02:00
Peyman M
09a5cd0dee Add Persian (fa) translation to the default themes (#2787) 2022-03-26 10:51:28 +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
Álvaro Mondéjar
b4fd3411f2 Fix mistake in docs about nav configuration (#2636) 2021-10-26 20:40:04 +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
6b72eef748 We can again announce support of zh_CN locale (#2609)
This reverts commit 1c72c12472.
2021-10-11 19:20:27 +02:00
Jules Topart
0d8fc8b922 user guide: correct word repetition (#2567) 2021-09-10 18:08:02 +02:00
Goto Hayato
519d2d32c3 Add Japanese (ja) translation for built-in themes (#2525) 2021-09-07 22:30:18 +02:00
Álvaro Mondéjar
4d1d1c1ba5 Fix various typos using codespell (#2549) 2021-08-20 17:06:01 +02:00
Álvaro Mondéjar
98cc11a7de Fix minor errors in documentation (#2515) 2021-07-28 14:11:46 +02:00
Oleh Prypin
1c72c12472 Don't announce support of zh_CN locale yet, as there's a bug (#2510)
https://github.com/mkdocs/mkdocs/issues/2509
2021-07-18 20:57:54 +02:00
Oleh Prypin
e0ba6d7bd9 Tighten the docs and tests around site_url (#2506)
Some of the docs were accidentally reverted with other things, so I'm restoring them and adding a bit more.

Fixing an edge case: it is in fact possible to specify a URL with scheme and without netloc. Adding new tests to also catch that.
2021-07-17 03:11:30 +02:00
xingkong0113
b4a471b684 Merge branch 'master' into zh_CN 2021-07-14 06:19:42 +08:00
Oleh Prypin
b12804d97e Fix some spelling typos (#2489) 2021-07-13 19:07:59 +02:00
xingkong0113
c257235204 Update Docs 2021-07-13 20:06:32 +08:00
Oleh Prypin
ae556572d4 Revert "Ensure site_url and use_directory_urls do not conflict." (#2490)
This reverts commit b89ec5792e.

That commit claims to fix some bugs in interactions with `use_directory_urls`, but in fact there are currently no known unfixed bugs.
So there is no need to have that breaking change.
2021-07-12 22:26:04 +02:00
Waylan Limberg
80feaf03a4 Deprecate google_analytics config option.
A new replacement option (theme.analytics.gtag) was added to the built-in themes. Multiple different services could be offered under theme.analytics. At this time only support for gtag exists, but more could be added in the future.

Fixes #2252.
2021-06-02 11:02:01 -04:00
Waylan Limberg
57b5ccd7d6 Add support for Configuration Inheritance
* Support dict only markdown_extensions config
* Support dict only plugin config
* Remove explicit conversion to Unicode as PY2 is no longer supported.
* Refactor yaml_load so that is can recursively call itself.

Fixes #2218.
2021-06-01 14:50:00 -04:00
Waylan Limberg
d54419d54b Document deploying to local files 2021-05-18 13:13:05 -04:00