Merge remote-tracking branch 'origin/master' into ci

Author: oprypin

.gitattributes

@@ -1,10 +1,10 @@
 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
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/** linguist-vendored
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/base.js linguist-vendored=false
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/css/** linguist-vendored
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/css/base.css linguist-vendored=false
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/** linguist-vendored
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/theme.js linguist-vendored=false
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/css/** linguist-vendored
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/css/theme_extra.css linguist-vendored=false
 docs/img/plugin-events.svg linguist-generated

.github/workflows/ci.yml

@@ -9,6 +9,7 @@ defaults:
     shell: bash
 jobs:
   test:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       fail-fast: false
       matrix:
@@ -63,7 +64,9 @@ jobs:
         if: matrix.versions != 'minimal'
         run: |
           hatch run +py=${{matrix.python}} integration:test
+
   style:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
       - name: Download source
@@ -100,6 +103,7 @@ jobs:
         run: hatch run lint:spelling
 
   package:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -114,7 +118,7 @@ jobs:
       - name: Check packaged files
         shell: bash -e -x {0}
         run: |
-          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})
+          expected_wheel=(-eproperdocs/{templates/sitemap.xml,config/base.py,py.typed,contrib/search/lunr-language/lunr.nl.js})
+          expected_sdist=("${expected_wheel[@]}" -epyproject.toml)
           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/deploy-docs.yml

@@ -6,6 +6,7 @@ on:
     - cron: '0 6 * * 6'
 jobs:
   build:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
       - name: Download source

.jshintignore

@@ -1,9 +1,9 @@
 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
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/highlight.pack.js
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/bootstrap.bundle.min.js
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/modernizr-**.min.js
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/theme.js
+packages/properdocs-theme-readthedocs/properdocs_theme_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

@@ -25,7 +25,7 @@ It is particularly helpful if an issue report touches on all of these aspects:
 
 1.  What are you trying to achieve?
 
-2.  What is your `mkdocs.yml` configuration (+ other relevant files)? Preferably reduced to the minimal reproducible example.
+2.  What is your `properdocs.yml` configuration (+ other relevant files)? Preferably reduced to the minimal reproducible example.
 
 3.  What did you expect to happen when applying this setup?
 
@@ -119,7 +119,7 @@ Documentation files are also checked by markdownlint, so you should run this as
 hatch run lint:check
 ```
 
-If you add a new plugin to mkdocs.yml, you don't need to add it to any "requirements" file, because that is managed automatically.
+If you add a new plugin to properdocs.yml, you don't need to add it to any "requirements" file, because that is managed automatically.
 
 > INFO: If you don't want to use Hatch, for documentation you can install requirements into a virtualenv, in one of these ways (with `.venv` being the virtualenv directory):
 >
@@ -159,8 +159,12 @@ updated by running the `extract_messages` command. To update the
 `pot` file for both built-in themes, run these commands:
 
 ```bash
-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
+(cd packages/properdocs-theme-mkdocs/ && \
+pybabel extract --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file babel.cfg --output-file properdocs_theme_mkdocs/messages.pot properdocs_theme_mkdocs
+)
+(cd packages/properdocs-theme-readthedocs/ && \
+pybabel extract --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file babel.cfg --output-file properdocs_theme_readthedocs/messages.pot properdocs_theme_readthedocs
+)
 ```
 
 The updated `pot` file should be included in a PR with the updated template.

README.md

@@ -1,76 +1,85 @@
 # ProperDocs
 
-> *Project documentation with Markdown*
-
 [![PyPI Version][pypi-v-image]][pypi-v-link]
 [![Build Status][GHAction-image]][GHAction-link]
 
-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.
+ProperDocs is a static site generator intended for project documentation. Source files are written in Markdown and converted to static HTML during the build process.
+
+Project configuration is defined in a YAML configuration file (`properdocs.yml`). This file specifies the documentation structure, theme configuration, and optional plugin settings.
+
+ProperDocs supports extension through plugins, themes and Markdown extensions.
 
-Please see the [Documentation][properdocs] for an introductory tutorial and a full
-user guide.
+For usage instructions and examples, see the Documentation.
+
+---
 
 ## Features
 
-- Build static HTML files from Markdown files.
-- 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!
+Current functionality includes:
+
+- Conversion of Markdown source files into static HTML pages
+- YAML-based configuration
+- Plugin system for extending functionality
+- Support for Markdown extensions
+- Support for third-party themes
+- Static output suitable for deployment on standard web servers
+
+Additional functionality is available through plugins.
+
+---
 
 ## Support
 
-If you need help with ProperDocs, do not hesitate to get in contact with us!
+If you encounter problems while using ProperDocs, the following resources are available:
 
 -   For questions and high-level discussions, use **[Discussions]** on GitHub.
-    -   For small questions, a good alternative is the **[Chat room]** on
-        Gitter/Matrix.
+    - For small questions, a good alternative is the **[Discord server]**.
 -   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 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].
+Support is generally limited to **core ProperDocs functionality**. Issues related to third-party themes, plugins or extensions should normally be reported to the maintainers of those projects.
+
+Questions about such components may still be discussed in chat.
 
-Make sure to stick around to answer some questions as well!
+---
 
 ## Links
 
 - [Official Documentation][properdocs]
 - [Latest Release Notes][release-notes]
 - [Catalog of third-party plugins, themes and recipes][catalog]
 
-## Contributing to ProperDocs
+---
+
+## Contributing
+
+Contributions are welcome.
 
-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.
+For development setup, coding guidelines and contribution workflow, see the **[Contributing Guide]**.
+
+---
 
 ## Code of Conduct
 
-Everyone interacting in the ProperDocs project's codebases, issue trackers, and
-discussion forums is expected to follow the [PyPA Code of Conduct].
+All participants in the ProperDocs project are expected to follow the **[PSF Code of Conduct]**.
+
+---
+
+## License
+
+ProperDocs is distributed under the [**BSD-2-Clause license**](LICENSE).
 
 <!-- Badges -->
 [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 -->
 [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
+[Discord server]: https://discord.gg/CwYAgEPHZd
 [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/
+[PSF Code of Conduct]: https://www.python.org/psf/conduct/
 [catalog]: https://github.com/properdocs/catalog
-
-## License
-
-[BSD-2-Clause](https://github.com/properdocs/properdocs/blob/master/LICENSE)