https://github.com/NaturalDocs/NaturalDocs
Natural Docs source code documentation system
https://github.com/NaturalDocs/NaturalDocs
documentation documentation-code documentation-generator documentation-tool naturaldocs
Last synced: 9 months ago
JSON representation
Natural Docs source code documentation system
- Host: GitHub
- URL: https://github.com/NaturalDocs/NaturalDocs
- Owner: NaturalDocs
- Created: 2017-04-17T02:14:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-17T23:56:18.000Z (10 months ago)
- Last Synced: 2025-03-18T00:32:35.240Z (10 months ago)
- Topics: documentation, documentation-code, documentation-generator, documentation-tool, naturaldocs
- Language: C#
- Homepage: http://www.naturaldocs.org
- Size: 22.3 MB
- Stars: 211
- Watchers: 19
- Forks: 36
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- fucking-awesome-cpp - Natural Docs - Natural Docs is an open source documentation generator for multiple programming languages. [AGPL/Proprietary] 🌎 [website](www.naturaldocs.org) (Documentation)
- awesome-cpp - Natural Docs - Natural Docs is an open source documentation generator for multiple programming languages. [AGPL/Proprietary] [website](https://www.naturaldocs.org) (Documentation)
README
# Natural Docs
Natural Docs is an open source documentation generator for
[multiple programming languages](https://www.naturaldocs.org/languages). You document your code in a
[natural syntax](https://www.naturaldocs.org/features/comments) that reads like plain English. Natural Docs then scans
your code and builds [high-quality HTML documentation](https://www.naturaldocs.org/features/output) from it.
More information is available on [naturaldocs.org](https://www.naturaldocs.org), including:
- [Downloads](https://www.naturaldocs.org/download)
- [Features](https://www.naturaldocs.org/features)
- [Supported Languages](https://www.naturaldocs.org/languages)
- [Getting Started](https://www.naturaldocs.org/getting_started)
- [Example Output](https://www.naturaldocs.org/documentation)
You can also join the community:
- [Mailing List](https://www.naturaldocs.org/mailing_list)
- [Support](https://www.naturaldocs.org/support)
- [Discussion](https://www.reddit.com/r/NaturalDocs)
- [Sponsor Natural Docs' development](https://github.com/sponsors/NaturalDocs)
Natural Docs is licensed under the GNU Affero General Public License, version 3. See
[this page for the full details.](https://www.naturaldocs.org/license/)