https://github.com/chances/wren-docs
Documentation generator for Wren modules
https://github.com/chances/wren-docs
documentation-generator wren wren-module
Last synced: 3 months ago
JSON representation
Documentation generator for Wren modules
- Host: GitHub
- URL: https://github.com/chances/wren-docs
- Owner: chances
- License: mit
- Created: 2024-01-25T00:58:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T01:33:00.000Z (over 2 years ago)
- Last Synced: 2025-02-27T00:41:15.254Z (over 1 year ago)
- Topics: documentation-generator, wren, wren-module
- Language: Wren
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wren Documentation Generator
Documentation generator for [Wren](https://wren.io) modules.
This tool parses Wren files, looking for documentation comments:
- `///`, and
- `/** */`
Generated documentation is saved to `./docs`.
## Features
- GitHub Flavored Markdown
## Prior Art
- The D programming language's [documentation generator](https://dlang.org/spec/ddoc.html) (AKA DDoc).
- The Domepunk [documentation generator](https://github.com/NinjasCL/domepunk/blob/main/tools/docs/__main__.py).
## License
[MIT License](https://opensource.org/licenses/MIT)
Copyright © 2024 Chance Snow. All rights reserved.