centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 18:08:31 +07:00
Code Issues Packages Projects Releases Wiki Activity
1,861 Commits 21 Branches 61 Tags
395daa05fb41fad052d644fb0ac0cc22f6065a5e
Commit Graph

1861 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Oleh Prypin
395daa05fb Merge remote-tracking branch 'origin/master' into getdeps 2023-06-04 23:24:58 +02:00
Oleh Prypin
41c6ee2de7 Enforce that imports are under if TYPE_CHECKING if possible (#3236) 2023-06-03 15:51:18 +02:00
Oleh Prypin
1363c7c390 Upgrade PyPy in CI 2023-06-03 15:36:39 +02:00
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
Oleh Prypin
8ecdfb2510 Clarify that Private config can be accessed, add a type to mdx_configs (#3229) 2023-05-26 18:54:32 +02:00
Oleh Prypin
562d5e14c1 Un-pin upper version of Python-Markdown (#3222) 
Reverts commit dd7986ff7b
 2023-05-18 18:44:44 +02:00
Oleh Prypin
62e312478e Modernize type annotations using pyupgrade (#3219) 
* https://peps.python.org/pep-0563/ - Postponed Evaluation of Annotations
* https://peps.python.org/pep-0585/ - Type Hinting Generics In Standard Collections
* https://peps.python.org/pep-0604/ - Allow writing union types as `X | Y`
 2023-05-14 22:49:34 +02:00
Oleh Prypin
3eb834ebd1 Remove deprecated localization commands (#3218) 2023-05-14 22:40:51 +02:00
Oleh Prypin
566a5bdda8 Allow paths traversing above the root - in nav and extra_ (#3010) 
+ Refactor and expand tests for normalize_url
 2023-05-09 20:56:54 +02:00
Oleh Prypin
5c9e4dcfad Merge pull request #3209 from mkdocs/desturi 
Allow to set a different `dest_uri` when creating a `File`
 2023-05-08 22:14:57 +02:00
Oleh Prypin
4e0429e8f5 Cache the value of documentation_pages 2023-05-07 17:29:03 +02:00
Oleh Prypin
d5af6426c5 Allow to set a different dest_uri when creating a File 2023-05-07 17:29:03 +02:00
Zac Knitter
2a232bf153 Update customizing-your-theme.md (#3215) 
Fixed typo
 2023-05-07 10:20:05 +02:00
Oleh Prypin
b776ad8820 Deprecate mkdocs.utils.warning_filter (#3008) 2023-05-04 21:59:58 +02:00
Kyle McNally
3c3670d92c Upgrade readthedocs theme to v1.2.0 (#3058) 
* New styles for breadcrumbs and kbd tag
* Fix formatting of: definition lists, citations, table cells with multiple paragraphs,
 2023-05-04 21:59:14 +02:00
Oleh Prypin
3d1b0113c2 Release 1.4.3 (#3208) 1.4.3 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
36205e30dd New get-deps command: infer PyPI depedencies from mkdocs.yml 
The user story is that the following command should let you "just build" any MkDocs site:

    pip install $(mkdocs get-deps) && mkdocs build

This cross-references 2 files:

* mkdocs.yml - `theme`, `plugins`, `markdown_extensions`
* projects.yaml - a registry of all popular MkDocs-related projects and which entry points they provide - downloaded on the fly

-and prints the names of Python packages from PyPI that need to be installed to build the current MkDocs project
 2023-05-01 19:02:22 +02:00
Julien Bidoret
ea1c6c468d Highlight.js style declaration in readthedocs theme (#3199) 
Co-authored-by: Oleh Prypin <oleh@pryp.in>
 2023-04-28 16:44:17 +02:00
Daniel Mundra
97440caf63 Add search input field labels using aria-label (#3046) 
* Adding aria-label to search input on the search.html page
* Adding aria-label to the search input field for the search box
 2023-04-28 16:28:02 +02:00
Micah Jerome Ellison
f3f6631d2a Fix accessibility issue with top-level breadcrumb in ReadTheDocs theme (#3129) 
Change top-level breadcrumb link's inappropriate alt tag to aria-label for accessibility

Co-authored-by: Oleh Prypin <oleh@pryp.in>
 2023-04-28 16:25:15 +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
052e023477 Revert functional part of previous commit - not all hosts have https 2023-04-27 19:14:13 +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
f5a9a7b38a Add hooks to sys.modules because some Python features rely on this (#3193) 2023-04-22 12:25:36 +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
Muescha
635dfc1a33 Docs: fix twitter link in the footer (#3094) 2023-04-21 22:15:26 +02:00
Oleh Prypin
7d32815367 Apply the same to mkdocs theme 2023-04-21 22:04:49 +02:00
少个分号
5de7903c5a fix wrong translation for zh 2023-04-21 22:04:49 +02:00
Henock Teshome
9e12a521e0 Use f-string in another place (#3156) 2023-04-21 19:27:23 +02:00
Mark De Ruyter
c32ce4d923 Fixes Page class references in documentation (#3117) 
mkdocs.nav.Pages => mkdocs.structure.pages.Page
 2023-04-21 19:18:45 +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
Elisei Roca
0e6a1c204c Remove executable bit from tests/__init__.py (#3107) 2023-04-21 19:13:33 +02:00
Oleh Prypin
25cfda3fe7 Fix type annotations according to mypy 2023-04-10 21:25:00 +02:00
Oleh Prypin
11f8f3a2a3 Spelling fix 2023-04-10 21:24:55 +02:00
Oleh Prypin
07a297b3b4 Skip entries with missing abs_url from sitemap 2023-04-10 21:23:12 +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) 1.4.2 2022-11-01 19:23:29 +01:00
Oleh Prypin
c99ec45a32 Support multiple instances of the same plugin (#3027) 
Depending on what a plugin does, say if it "adds a thing" into the site, it can be reasonable to allow it to be specified multiple times in the `plugins:` list, so it can "add multiple things". Previously such a use case was completely not predicted in MkDocs, so it silently passes but is bugged - the plugin runs twice but with only one of the configs both times.

So, this commit addresses that by registering a plugin `- foo:` as `'foo'`, and then if another plugin `- foo:` appears, it gets registered as `'foo #2'` (the name affects primarily just how it's referred to in warnings and errors).

By default, a warning will appear from MkDocs anyway, unless the plugin adds a class variable `supports_multiple_instances = True`.
 2022-11-01 18:53:43 +01:00
Oleh Prypin
452c39eae2 Chore dependency upgrade 2022-10-29 22:44:38 +02:00
pcgaustad
f190c35a99 Translate mkdocs theme to Norwegian (nb and nn) (#3024) 2022-10-29 14:55:02 +02:00
Oleh Prypin
c576f07d30 Declare support for Python 3.11 (#3020) 2022-10-29 14:48:00 +02:00
Oleh Prypin
32359f3e93 Relative links end with slash even for homepage links (#3022) 
Fixes #3015
 2022-10-29 14:41:50 +02:00
Oleh Prypin
1fa2af7926 Expand type checking coverage (#3019) 2022-10-25 21:59:30 +02:00
Oleh Prypin
d76cae9059 Merge pull request #3016 from mkdocs/optw 
Update warnings of config options
 2022-10-23 17:57:29 +02:00
Oleh Prypin
9d73c2a824 Reduce redundancy in config errors/warnings 2022-10-21 22:29:42 +02:00