Skip to content

Commit 762c44c

Browse files
JP76Andre601oprypin
authored
Update README.md (#29)
Co-authored-by: Andre_601 <11576465+Andre601@users.noreply.github.com> Co-authored-by: Oleh Prypin <oleh@pryp.in>
1 parent 1e2935a commit 762c44c

File tree

1 file changed

+42
-32
lines changed

1 file changed

+42
-32
lines changed

README.md

Lines changed: 42 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,85 @@
11
# ProperDocs
22

3-
> *Project documentation with Markdown*
4-
53
[![PyPI Version][pypi-v-image]][pypi-v-link]
64
[![Build Status][GHAction-image]][GHAction-link]
75

8-
ProperDocs is a **fast**, **simple** and **downright gorgeous** static site
9-
generator that's geared towards building project documentation. Documentation
10-
source files are written in Markdown, and configured with a single YAML
11-
configuration file. It is designed to be easy to use and can be extended with
12-
third-party themes, plugins, and Markdown extensions.
6+
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.
7+
8+
Project configuration is defined in a YAML configuration file (`properdocs.yml`). This file specifies the documentation structure, theme configuration, and optional plugin settings.
9+
10+
ProperDocs supports extension through plugins, themes and Markdown extensions.
1311

14-
Please see the [Documentation][properdocs] for an introductory tutorial and a full
15-
user guide.
12+
For usage instructions and examples, see the Documentation.
13+
14+
---
1615

1716
## Features
1817

19-
- Build static HTML files from Markdown files.
20-
- Use Plugins and Markdown Extensions to enhance ProperDocs.
21-
- Use third party themes or create your own.
22-
- Publish your documentation anywhere that static files can be served.
23-
- Much more!
18+
Current functionality includes:
19+
20+
- Conversion of Markdown source files into static HTML pages
21+
- YAML-based configuration
22+
- Plugin system for extending functionality
23+
- Support for Markdown extensions
24+
- Support for third-party themes
25+
- Static output suitable for deployment on standard web servers
26+
27+
Additional functionality is available through plugins.
28+
29+
---
2430

2531
## Support
2632

27-
If you need help with ProperDocs, do not hesitate to get in contact with us!
33+
If you encounter problems while using ProperDocs, the following resources are available:
2834

2935
- For questions and high-level discussions, use **[Discussions]** on GitHub.
3036
- For small questions, a good alternative is the **[Discord server]**.
3137
- To report a bug or make a feature request, open an **[Issue]** on GitHub.
3238

33-
Please note that we may only provide
34-
support for problems/questions regarding core features of ProperDocs. Any
35-
questions or bug reports about features of third-party themes, plugins,
36-
extensions or similar should be made to their respective projects.
37-
But, such questions are *not* banned from the [chat room].
39+
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.
40+
41+
Questions about such components may still be discussed in chat.
3842

39-
Make sure to stick around to answer some questions as well!
43+
---
4044

4145
## Links
4246

4347
- [Official Documentation][properdocs]
4448
- [Latest Release Notes][release-notes]
4549
- [Catalog of third-party plugins, themes and recipes][catalog]
4650

47-
## Contributing to ProperDocs
51+
---
52+
53+
## Contributing
54+
55+
Contributions are welcome.
4856

49-
The ProperDocs project welcomes, and depends on, contributions from developers and
50-
users in the open source community. Please see the [Contributing Guide] for
51-
information on how you can help.
57+
For development setup, coding guidelines and contribution workflow, see the **[Contributing Guide]**.
58+
59+
---
5260

5361
## Code of Conduct
5462

55-
Everyone interacting in the ProperDocs project's codebases, issue trackers, and
56-
discussion forums is expected to follow the [PyPA Code of Conduct].
63+
All participants in the ProperDocs project are expected to follow the **[PSF Code of Conduct]**.
64+
65+
---
66+
67+
## License
68+
69+
ProperDocs is distributed under the [**BSD-2-Clause license**](LICENSE).
5770

5871
<!-- Badges -->
5972
[pypi-v-image]: https://img.shields.io/pypi/v/properdocs.svg
6073
[pypi-v-link]: https://pypi.org/project/properdocs/
6174
[GHAction-image]: https://github.com/properdocs/properdocs/actions/workflows/ci.yml/badge.svg
6275
[GHAction-link]: https://github.com/properdocs/properdocs/actions/workflows/ci.yml
76+
6377
<!-- Links -->
6478
[properdocs]: https://properdocs.org
6579
[Issue]: https://github.com/properdocs/properdocs/issues
6680
[Discussions]: https://github.com/properdocs/properdocs/discussions
6781
[Discord server]: https://discord.gg/CwYAgEPHZd
6882
[release-notes]: https://properdocs.org/about/release-notes/
6983
[Contributing Guide]: https://properdocs.org/about/contributing/
70-
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
84+
[PSF Code of Conduct]: https://www.python.org/psf/conduct/
7185
[catalog]: https://github.com/properdocs/catalog
72-
73-
## License
74-
75-
[BSD-2-Clause](https://github.com/properdocs/properdocs/blob/master/LICENSE)

0 commit comments

Comments
 (0)