Merge pull request #3205 from mkdocs/getdeps

New `get-deps` command: infer PyPI dependencies from mkdocs.yml
This commit is contained in:
Oleh Prypin
2023-06-09 20:05:07 +02:00
committed by GitHub
14 changed files with 530 additions and 16 deletions

View File

@@ -16,8 +16,8 @@ pip install mkdocs-foo-plugin
```
Once a plugin has been successfully installed, it is ready to use. It just needs
to be [enabled](#using-plugins) in the configuration file. The [Best-of-MkDocs]
page has a large list of plugins that you can install and use.
to be [enabled](#using-plugins) in the configuration file. The [Catalog]
repository has a large ranked list of plugins that you can install and use.
## Using Plugins
@@ -514,6 +514,10 @@ entry_points={
Note that registering a plugin does not activate it. The user still needs to
tell MkDocs to use it via the config.
### Publishing a Plugin
You should publish a package on [PyPI], then add it to the [Catalog] for discoverability. Plugins are strongly recommended to have a unique plugin name (entry point name) according to the catalog.
[BasePlugin]:#baseplugin
[config]: ../user-guide/configuration.md#plugins
[entry point]: #entry-point
@@ -526,5 +530,6 @@ tell MkDocs to use it via the config.
[post_template]: #on_post_template
[static_templates]: ../user-guide/configuration.md#static_templates
[Template Events]: #template-events
[Best-of-MkDocs]: https://github.com/mkdocs/best-of-mkdocs
[catalog]: https://github.com/mkdocs/catalog
[on_build_error]: #on_build_error
[PyPI]: https://pypi.org/

View File

@@ -6,8 +6,8 @@ A guide to creating and distributing custom themes.
NOTE:
If you are looking for existing third party themes, they are listed in the
[community wiki] page and [Best-of-MkDocs]. If you want to share a theme you create, you
should list it there.
[community wiki] page and the [MkDocs project catalog][catalog]. If you want to
share a theme you create, you should list it there.
When creating a new theme, you can either follow the steps in this guide to
create one from scratch or you can download the `mkdocs-basic-theme` as a
@@ -16,7 +16,7 @@ this base theme on [GitHub][basic theme]**. It contains detailed comments in
the code to describe the different features and their usage.
[community wiki]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes
[Best-of-MkDocs]: https://github.com/mkdocs/best-of-mkdocs#-theming
[catalog]: https://github.com/mkdocs/catalog#-theming
[basic theme]: https://github.com/mkdocs/mkdocs-basic-theme
## Creating a custom theme

View File

@@ -33,7 +33,7 @@ configuration file. Start by reading the [introductory tutorial], then check the
<a href="user-guide/choosing-your-theme/#readthedocs">readthedocs</a>,
select one of the third-party themes
(on the <a href="https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes">MkDocs Themes</a> wiki page
as well as <a href="https://github.com/mkdocs/best-of-mkdocs#-theming">Best-of-MkDocs</a>),
as well as the <a href="https://github.com/mkdocs/catalog#-theming">MkDocs Catalog</a>),
or <a href="dev-guide/themes/">build your own</a>.
</p>
</div>

View File

@@ -218,7 +218,7 @@ theme supports the following options:
## Third Party Themes
A list of third party themes can be found at the [community wiki] page and [Best-of-MkDocs]. If you have created your own, please add them there.
A list of third party themes can be found at the [community wiki] page and [the ranked catalog][catalog]. If you have created your own, please add them there.
[third party themes]: #third-party-themes
[theme]: configuration.md#theme
@@ -229,5 +229,5 @@ A list of third party themes can be found at the [community wiki] page and [Best
[upgrade-GA4]: https://support.google.com/analytics/answer/9744165?hl=en&ref_topic=9303319
[Read the Docs]: https://readthedocs.org/
[community wiki]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes
[Best-of-MkDocs]: https://github.com/mkdocs/best-of-mkdocs#-theming
[catalog]: https://github.com/mkdocs/catalog#-theming
[localizing your theme]: localizing-your-theme.md

View File

@@ -575,7 +575,7 @@ This alternative syntax is required if you intend to override some options via
> which are available out-of-the-box. For a list of configuration options
> available for a given extension, see the documentation for that extension.
>
> You may also install and use various third party extensions ([Python-Markdown wiki], [Best-of-MkDocs]). Consult
> You may also install and use various third party extensions ([Python-Markdown wiki], [MkDocs project catalog][catalog]). Consult
> the documentation provided by those extensions for installation instructions
> and available configuration options.
@@ -964,7 +964,7 @@ path based options in the primary configuration file only.
[smarty]: https://python-markdown.github.io/extensions/smarty/
[exts]: https://python-markdown.github.io/extensions/
[Python-Markdown wiki]: https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions
[Best-of-MkDocs]: https://github.com/mkdocs/best-of-mkdocs
[catalog]: https://github.com/mkdocs/catalog
[configuring pages and navigation]: writing-your-docs.md#configure-pages-and-navigation
[theme_dir]: customizing-your-theme.md#using-the-theme_dir
[choosing your theme]: choosing-your-theme.md