24 Commits

Author SHA1 Message Date
Oleh Prypin
9af473c71c Let's use pymdownx.snippets for the move 2023-12-10 14:10:01 +01:00
Oleh Prypin
f40f3bfe92 Move CONTRIBUTING.md doc to the root 2023-12-10 10:41:22 +01:00
Vedran Miletić
0bf4963090 Quote pip arguments containing square brackets (#3456)
This is strictly necessary when using non-bash shells (e.g. tcsh).
2023-11-01 17:20:14 +01:00
Timothée Mazzucotelli
45c8b9669b Add note about formatting code (#3244) 2023-06-07 00:43:45 +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
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
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
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
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
Álvaro Mondéjar
ea0ac7a07a Update contribution guide links (#2548) 2021-08-20 12:30:26 +02:00
Urs Liska
47d7571697 Add link to README to contributing.md (#1978)
In https://github.com/mkdocs/mkdocs/issues/1972#issuecomment-582952604
I was pointed to the README, but I hadn't looked for contact information there.
I think looking on the website is a reasonable way, and pointing to the README
from the "Contributing" page looks like a good help to me.
2021-07-08 23:43:20 +02:00
Ultrabug
e1b77ab66e Support theme localization
A framework for translating themes as been added, which includes:

1. Use of Jinja's `i18n` plugin for translating phrases in templates (not page content).
2. A French translation of the built-in themes (contributions in other languages are welcome).
3. A new `theme.locale` option to define the locale/language of the site.
4. The search plugin uses the value of `theme.locale` as its default 'lang'.
5. Third party themes may chose to use the framework (use is optional).
6. A documented workflow for translating MkDocs built-in themes.
7. Custom tooling for use by translators and theme devs.

The dependencies are not installed by default and are not needed to use MkDocs without translations. However, for anyone who wants to make use of the features, `pip install mkdocs[i18n]` will install all necessary dependencies.

Relates to #211.
2021-05-06 14:30:21 -04:00
Maximilian Albert
bf0698a94a Fix link to virtualenv user guide 2020-02-11 14:23:44 -05:00
Heini Fagerlund
eb5f3f84e5 contributing.md: fix typos, add link (#1774) 2019-03-25 17:43:44 -04:00
Dougal Matthews
9a0e35c774 Adopt the PyPA Code of Conduct 2016-06-28 21:22:22 +01:00
Dougal Matthews
d8d8341808 Fix the feedback from LinkChecker and enforce it in the Travis config 2016-04-29 11:09:48 +01:00
Prayag Verma
cc1f81e9de Minor typo
Remove extra `the`
2016-02-01 01:52:19 +05:30
Waylan Limberg
bd33c4b76b Corrected lint errors in Markdown docs.
Also added README.md and CONTRIBUTING.md to the linter.

Note, that I am still getting one failer (in two locations). However
I consider that failer a bug in the linter and have reported it
upstream. We could disable that Rule (MD031), but as we are not
requiring the lint rules to pass presently, I just left it alone.

Also, while the code linter is set to allow lines 119 chars long,
I am using the Markdown linter's default of 80. Prose is easier to
read with shorter line lenghts, so I think it makes more sense to
use the default. Also, changing the default would have required
adding a config file. Adding a Ruby file for only one minor setting
seems silly, so I left it alone.
2015-08-13 10:18:34 -04:00
Dougal Matthews
0130a90f2b Fixed links in the contributing page 2015-06-05 08:36:08 +01:00
Dougal Matthews
f6b61d863c Add a note about installing the dev version
Fixes #548
2015-05-26 09:43:13 +01:00
Dougal Matthews
7ef39aa4e2 Some minor updates to the documentation
- Added a small section about where to get help
- Updated link to the contributing guide
- Improved some o the code highlighting
2015-04-14 08:30:44 +01:00
Dougal Matthews
bdbf2ce5ed Added an initial Contributing guide 2015-04-03 14:47:00 +01:00