From 67b9dd3a9f17e7f6f2248ce05b83d3ddf056a509 Mon Sep 17 00:00:00 2001 From: JP76 Date: Sun, 15 Mar 2026 19:44:59 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 72 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 41 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 1f001fed..b3520a64 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,44 @@ -# ProperDocs +## ProperDocs -> *Project documentation with Markdown* +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. -[![PyPI Version][pypi-v-image]][pypi-v-link] -[![Build Status][GHAction-image]][GHAction-link] +Project configuration is defined in a YAML configuration file (in `properdocs.yml`). This file specifies documentation structure, theme configuration, and optional plugin settings. -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 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 +* Built-in themes +* Support for third-party themes +* Static output suitable for deployment on standard web servers + +Additional functionality may be 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 **[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 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 @@ -45,16 +46,25 @@ Make sure to stick around to answer some questions as well! - [Latest Release Notes][release-notes] - [Catalog of third-party plugins, themes and recipes][catalog] -## Contributing to ProperDocs +--- + +## Contributing -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. +Contributions are welcome. + +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 **PyPA Code of Conduct**. + +--- + +## License + +ProperDocs is distributed under the **BSD-2-Clause license**. [pypi-v-image]: https://img.shields.io/pypi/v/properdocs.svg From 4624b5ef1d1fa7a952fb1e717dbf0e3efbf174a3 Mon Sep 17 00:00:00 2001 From: JP76 Date: Fri, 20 Mar 2026 22:55:41 +0100 Subject: [PATCH 2/3] Make changes --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b3520a64..9da83edf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -## ProperDocs +# ProperDocs 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 (in `properdocs.yml`). This file specifies documentation structure, theme configuration, and optional plugin settings. +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. @@ -18,11 +18,10 @@ Current functionality includes: * YAML-based configuration * Plugin system for extending functionality * Support for Markdown extensions -* Built-in themes * Support for third-party themes * Static output suitable for deployment on standard web servers -Additional functionality may be available through plugins. +Additional functionality is available through plugins. --- @@ -31,7 +30,7 @@ Additional functionality may be available through plugins. 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 **[Chat room]** on Discord. - To report a bug or make a feature request, open an **[Issue]** on GitHub. 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. @@ -58,29 +57,26 @@ For development setup, coding guidelines and contribution workflow, see the **Co ## Code of Conduct -All participants in the ProperDocs project are 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**. +ProperDocs is distributed under the [**BSD-2-Clause license**](LICENSE). [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 + [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 +[Chat room]: https://discord.gg/properdocs [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) From b3e0c4a3cb2e76a4ceeecc51f711282a3ed84168 Mon Sep 17 00:00:00 2001 From: JP76 Date: Fri, 20 Mar 2026 23:44:32 +0100 Subject: [PATCH 3/3] Update README.md Co-authored-by: Andre_601 <11576465+Andre601@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9da83edf..38f8272a 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ ProperDocs is distributed under the [**BSD-2-Clause license**](LICENSE). [properdocs]: https://properdocs.org [Issue]: https://github.com/properdocs/properdocs/issues [Discussions]: https://github.com/properdocs/properdocs/discussions -[Chat room]: https://discord.gg/properdocs +[Chat room]: https://discord.gg/CwYAgEPHZd [release-notes]: https://properdocs.org/about/release-notes/ [Contributing Guide]: https://properdocs.org/about/contributing/ [PSF Code of Conduct]: https://www.python.org/psf/conduct/