Merge pull request #12 from ProperDocs/rename

Rename the project from "MkDocs" to "ProperDocs"

Author: oprypin

.gitattributes

@@ -1,10 +1,10 @@
-mkdocs/contrib/search/lunr-language/** linguist-vendored
-mkdocs/themes/mkdocs/js/** linguist-vendored
-mkdocs/themes/mkdocs/js/base.js linguist-vendored=false
-mkdocs/themes/mkdocs/css/** linguist-vendored
-mkdocs/themes/mkdocs/css/base.css linguist-vendored=false
-mkdocs/themes/readthedocs/js/** linguist-vendored
-mkdocs/themes/readthedocs/js/theme.js linguist-vendored=false
-mkdocs/themes/readthedocs/css/** linguist-vendored
-mkdocs/themes/readthedocs/css/theme_extra.css linguist-vendored=false
+properdocs/contrib/search/lunr-language/** linguist-vendored
+properdocs/themes/mkdocs/js/** linguist-vendored
+properdocs/themes/mkdocs/js/base.js linguist-vendored=false
+properdocs/themes/mkdocs/css/** linguist-vendored
+properdocs/themes/mkdocs/css/base.css linguist-vendored=false
+properdocs/themes/readthedocs/js/** linguist-vendored
+properdocs/themes/readthedocs/js/theme.js linguist-vendored=false
+properdocs/themes/readthedocs/css/** linguist-vendored
+properdocs/themes/readthedocs/css/theme_extra.css linguist-vendored=false
 docs/img/plugin-events.svg linguist-generated

.github/workflows/ci.yml

@@ -98,7 +98,7 @@ jobs:
       - name: Check packaged files
         shell: bash -e -x {0}
         run: |
-          expected_wheel=(-emkdocs/{templates/sitemap.xml,config/base.py,py.typed,contrib/search/lunr-language/lunr.nl.js,themes/{mkdocs,readthedocs}/{base.html,locales/{de,es}/LC_MESSAGES/messages.mo}})
+          expected_wheel=(-eproperdocs/{templates/sitemap.xml,config/base.py,py.typed,contrib/search/lunr-language/lunr.nl.js,themes/{mkdocs,readthedocs}/{base.html,locales/{de,es}/LC_MESSAGES/messages.mo}})
           expected_sdist=("${expected_wheel[@]}" -e{pyproject.toml,hatch_build.py})
-          test "$(tar -ztf dist/mkdocs-*.tar.gz | grep -F "${expected_sdist[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_sdist[@]}"
-          test "$(unzip -l dist/mkdocs-*any.whl | grep -F "${expected_wheel[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_wheel[@]}"
+          test "$(tar -ztf dist/properdocs-*.tar.gz | grep -F "${expected_sdist[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_sdist[@]}"
+          test "$(unzip -l dist/properdocs-*any.whl | grep -F "${expected_wheel[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_wheel[@]}"

.github/workflows/docs.yml

@@ -17,4 +17,4 @@ jobs:
       - name: Install dependencies
         run: pip install --no-deps -r requirements/requirements-docs.txt
       - name: Build site
-        run: mkdocs build --strict
+        run: properdocs build --strict

.gitignore

@@ -66,5 +66,5 @@ target/
 venv/
 ENV/
 
-# MkDocs documentation
+# ProperDocs documentation
 site*/

.jshintignore

@@ -1,9 +1,9 @@
-mkdocs/themes/**/js/jquery-**.min.js
-mkdocs/themes/mkdocs/js/highlight.pack.js
-mkdocs/themes/mkdocs/js/bootstrap.bundle.min.js
-mkdocs/themes/mkdocs/js/modernizr-**.min.js
-mkdocs/themes/readthedocs/js/theme.js
-mkdocs/themes/readthedocs/js/html5shiv.min.js
-mkdocs/contrib/search/templates/search/lunr.js
-mkdocs/contrib/search/lunr-language/lunr.**.js
-mkdocs/contrib/search/lunr-language/tinyseg.js
+properdocs/themes/**/js/jquery-**.min.js
+properdocs/themes/mkdocs/js/highlight.pack.js
+properdocs/themes/mkdocs/js/bootstrap.bundle.min.js
+properdocs/themes/mkdocs/js/modernizr-**.min.js
+properdocs/themes/readthedocs/js/theme.js
+properdocs/themes/readthedocs/js/html5shiv.min.js
+properdocs/contrib/search/templates/search/lunr.js
+properdocs/contrib/search/lunr-language/lunr.**.js
+properdocs/contrib/search/lunr-language/tinyseg.js

CONTRIBUTING.md

@@ -1,8 +1,8 @@
-# Contributing to MkDocs
+# Contributing to ProperDocs
 
-An introduction to contributing to the MkDocs project.
+An introduction to contributing to the ProperDocs project.
 
-The MkDocs project welcomes contributions from developers and
+The ProperDocs project welcomes contributions from developers and
 users in the open source community. Contributions can be made in a number of
 ways, a few examples are:
 
@@ -11,12 +11,12 @@ ways, a few examples are:
 - Bug reports and patch reviews
 
 For information about available communication channels please refer to the
-[README](https://github.com/mkdocs/mkdocs#readme) file in our
+[README](https://github.com/properdocs/properdocs#readme) file in our
 GitHub repository.
 
 ## Reporting an Issue
 
-Please include as much detail as you can. Let us know your platform and MkDocs
+Please include as much detail as you can. Let us know your platform and ProperDocs
 version. If the problem is visual (for example a theme or design issue), please
 add a screenshot. If you get an error, please include the full error message and
 traceback.
@@ -34,19 +34,19 @@ It is particularly helpful if an issue report touches on all of these aspects:
 ## Trying out the Development Version
 
 If you want to just install and try out the latest development version of
-MkDocs (in case it already contains a fix for your issue),
+ProperDocs (in case it already contains a fix for your issue),
 you can do so with the following command. This can be useful if you
 want to provide feedback for a new feature or want to confirm if a bug you
 have encountered is fixed in the git master. It is **strongly** recommended
 that you do this within a [virtualenv].
 
 ```bash
-pip install git+https://github.com/mkdocs/mkdocs.git
+pip install git+https://github.com/properdocs/properdocs.git
 ```
 
 ## Installing for Development
 
-Note that for development you can just use [Hatch] directly as described below. If you wish to install a local clone of MkDocs anyway, you can run `pip install --editable .`. It is **strongly** recommended that you do this within a [virtualenv].
+Note that for development you can just use [Hatch] directly as described below. If you wish to install a local clone of ProperDocs anyway, you can run `pip install --editable .`. It is **strongly** recommended that you do this within a [virtualenv].
 
 ## Installing Hatch
 
@@ -56,7 +56,7 @@ So first, [install it][install Hatch]. Ideally in an isolated way with **`pipx i
 
 ## Running all checks
 
-To run **all** checks that are required for MkDocs, just run the following command in the cloned MkDocs repository:
+To run **all** checks that are required for ProperDocs, just run the following command in the cloned ProperDocs repository:
 
 ```bash
 hatch run all
@@ -68,7 +68,7 @@ All checks need to pass.
 
 ### Running tests
 
-To run the test suite for MkDocs, run the following commands:
+To run the test suite for ProperDocs, run the following commands:
 
 ```bash
 hatch run test:test
@@ -81,7 +81,7 @@ will be verified by [GitHub Actions] when you submit a pull request.
 
 ### Python code style
 
-Python code within MkDocs' code base is formatted using [Black] and [Isort] and lint-checked using [Ruff], all of which are configured in `pyproject.toml`.
+Python code within ProperDocs' code base is formatted using [Black] and [Isort] and lint-checked using [Ruff], all of which are configured in `pyproject.toml`.
 
 You can automatically check and format the code according to these tools with the following command:
 
@@ -103,7 +103,7 @@ There are several other checks, such as spelling and JS style. To run all of the
 hatch run lint:check
 ```
 
-### Documentation of MkDocs itself
+### Documentation of ProperDocs itself
 
 After making edits to files under the `docs/` dir, you can preview the site locally using the following command:
 
@@ -125,7 +125,7 @@ If you add a new plugin to mkdocs.yml, you don't need to add it to any "requirem
 >
 > ```bash
 > .venv/bin/pip install -r requirements/requirements-docs.txt  # Exact versions of dependencies.
-> .venv/bin/pip install -r $(mkdocs get-deps)  # Latest versions of all dependencies.
+> .venv/bin/pip install -r $(properdocs get-deps)  # Latest versions of all dependencies.
 > ```
 
 ## Translating themes
@@ -134,7 +134,7 @@ To localize a theme to your favorite language, follow the guide on [Translating
 
 ## Submitting Pull Requests
 
-If you're considering a large code contribution to MkDocs, please prefer to
+If you're considering a large code contribution to ProperDocs, please prefer to
 open an issue first to get early feedback on the idea.
 
 Once you think the code is ready to be reviewed, push
@@ -148,7 +148,7 @@ Do *not* add to *release-notes.md*, this will be written later.
 
 ### Submitting changes to the builtin themes
 
-When installed with `i18n` support (`pip install 'mkdocs[i18n]'`), MkDocs allows
+When installed with `i18n` support (`pip install 'properdocs[i18n]'`), ProperDocs allows
 themes to support being translated into various languages (referred to as
 locales) if they respect [Jinja's i18n extension] by wrapping text placeholders
 with `{% trans %}` and `{% endtrans %}` tags.
@@ -159,8 +159,8 @@ updated by running the `extract_messages` command. To update the
 `pot` file for both built-in themes, run these commands:
 
 ```bash
-pybabel extract --project=MkDocs --copyright-holder=MkDocs --msgid-bugs-address='https://github.com/mkdocs/mkdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file mkdocs/themes/babel.cfg --output-file mkdocs/themes/mkdocs/messages.pot mkdocs/themes/mkdocs
-pybabel extract --project=MkDocs --copyright-holder=MkDocs --msgid-bugs-address='https://github.com/mkdocs/mkdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file mkdocs/themes/babel.cfg --output-file mkdocs/themes/readthedocs/messages.pot mkdocs/themes/readthedocs
+pybabel extract --project=ProperDocs --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file properdocs/themes/babel.cfg --output-file properdocs/themes/mkdocs/messages.pot properdocs/themes/mkdocs
+pybabel extract --project=ProperDocs --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file properdocs/themes/babel.cfg --output-file properdocs/themes/readthedocs/messages.pot properdocs/themes/readthedocs
 ```
 
 The updated `pot` file should be included in a PR with the updated template.
@@ -175,7 +175,7 @@ file so that everything is ready for translators to do their job.
 
 ## Code of Conduct
 
-Everyone interacting in the MkDocs project's codebases, issue trackers, chat
+Everyone interacting in the ProperDocs project's codebases, issue trackers, chat
 rooms, and mailing lists is expected to follow the [PyPA Code of Conduct].
 
 [virtualenv]: https://virtualenv.pypa.io/en/latest/user_guide.html
@@ -184,7 +184,7 @@ rooms, and mailing lists is expected to follow the [PyPA Code of Conduct].
 [installing `pipx`]: https://pypa.github.io/pipx/installation/
 [GitHub Actions]: https://docs.github.com/actions
 [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
-[Translating Themes]: https://www.mkdocs.org/dev-guide/translations/
+[Translating Themes]: https://properdocs.org/dev-guide/translations/
 [Jinja's i18n extension]: https://jinja.palletsprojects.com/en/latest/extensions/#i18n-extension
 [Ruff]: https://docs.astral.sh/ruff/
 [Black]: https://black.readthedocs.io/

FUNDING.yml

@@ -1 +1 @@
-github: mkdocs
+github: properdocs

README.md

@@ -1,39 +1,39 @@
-# MkDocs
+# ProperDocs
 
 > *Project documentation with Markdown*
 
 [![PyPI Version][pypi-v-image]][pypi-v-link]
 [![Build Status][GHAction-image]][GHAction-link]
 [![Coverage Status][codecov-image]][codecov-link]
 
-MkDocs is a **fast**, **simple** and **downright gorgeous** static site
+ProperDocs is a **fast**, **simple** and **downright gorgeous** static site
 generator that's geared towards building project documentation. Documentation
 source files are written in Markdown, and configured with a single YAML
 configuration file. It is designed to be easy to use and can be extended with
 third-party themes, plugins, and Markdown extensions.
 
-Please see the [Documentation][mkdocs] for an introductory tutorial and a full
+Please see the [Documentation][properdocs] for an introductory tutorial and a full
 user guide.
 
 ## Features
 
 - Build static HTML files from Markdown files.
-- Use Plugins and Markdown Extensions to enhance MkDocs.
+- Use Plugins and Markdown Extensions to enhance ProperDocs.
 - Use the built-in themes, third party themes or create your own.
 - Publish your documentation anywhere that static files can be served.
 - Much more!
 
 ## Support
 
-If you need help with MkDocs, do not hesitate to get in contact with us!
+If you need help with ProperDocs, do not hesitate to get in contact with us!
 
 -   For questions and high-level discussions, use **[Discussions]** on GitHub.
     -   For small questions, a good alternative is the **[Chat room]** on
         Gitter/Matrix.
 -   To report a bug or make a feature request, open an **[Issue]** on GitHub.
 
 Please note that we may only provide
-support for problems/questions regarding core features of MkDocs. Any
+support for problems/questions regarding core features of ProperDocs. Any
 questions or bug reports about features of third-party themes, plugins,
 extensions or similar should be made to their respective projects.  
 But, such questions are *not* banned from the [chat room].
@@ -42,38 +42,38 @@ Make sure to stick around to answer some questions as well!
 
 ## Links
 
-- [Official Documentation][mkdocs]
+- [Official Documentation][properdocs]
 - [Latest Release Notes][release-notes]
 - [Catalog of third-party plugins, themes and recipes][catalog]
 
-## Contributing to MkDocs
+## Contributing to ProperDocs
 
-The MkDocs project welcomes, and depends on, contributions from developers and
+The ProperDocs project welcomes, and depends on, contributions from developers and
 users in the open source community. Please see the [Contributing Guide] for
 information on how you can help.
 
 ## Code of Conduct
 
-Everyone interacting in the MkDocs project's codebases, issue trackers, and
+Everyone interacting in the ProperDocs project's codebases, issue trackers, and
 discussion forums is expected to follow the [PyPA Code of Conduct].
 
 <!-- Badges -->
-[codecov-image]: https://codecov.io/github/mkdocs/mkdocs/coverage.svg?branch=master
-[codecov-link]: https://codecov.io/github/mkdocs/mkdocs?branch=master
-[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs.svg
-[pypi-v-link]: https://pypi.org/project/mkdocs/
-[GHAction-image]: https://github.com/mkdocs/mkdocs/actions/workflows/ci.yml/badge.svg
-[GHAction-link]: https://github.com/mkdocs/mkdocs/actions/workflows/ci.yml
+[codecov-image]: https://codecov.io/github/properdocs/properdocs/coverage.svg?branch=master
+[codecov-link]: https://codecov.io/github/properdocs/properdocs?branch=master
+[pypi-v-image]: https://img.shields.io/pypi/v/properdocs.svg
+[pypi-v-link]: https://pypi.org/project/properdocs/
+[GHAction-image]: https://github.com/properdocs/properdocs/actions/workflows/ci.yml/badge.svg
+[GHAction-link]: https://github.com/properdocs/properdocs/actions/workflows/ci.yml
 <!-- Links -->
-[mkdocs]: https://www.mkdocs.org
-[Issue]: https://github.com/mkdocs/mkdocs/issues
-[Discussions]: https://github.com/mkdocs/mkdocs/discussions
+[properdocs]: https://properdocs.org
+[Issue]: https://github.com/properdocs/properdocs/issues
+[Discussions]: https://github.com/properdocs/properdocs/discussions
 [Chat room]: https://gitter.im/mkdocs/community
-[release-notes]: https://www.mkdocs.org/about/release-notes/
-[Contributing Guide]: https://www.mkdocs.org/about/contributing/
+[release-notes]: https://properdocs.org/about/release-notes/
+[Contributing Guide]: https://properdocs.org/about/contributing/
 [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
-[catalog]: https://github.com/mkdocs/catalog
+[catalog]: https://github.com/properdocs/catalog
 
 ## License
 
-[BSD-2-Clause](https://github.com/mkdocs/mkdocs/blob/master/LICENSE)
+[BSD-2-Clause](https://github.com/properdocs/properdocs/blob/master/LICENSE)

docs/CNAME

@@ -1 +1 @@
-www.mkdocs.org
+properdocs.org