Crycco is a documentation generator written in Crystal and inspired by Docco. It creates documentation that combines source code with explanatory commentary, allowing developers to present their programs in a format that is easier to follow than reading the implementation alone.
The application processes source files, converts comments into formatted text and applies syntax highlighting to code. Its output can show explanations alongside the relevant implementation, making it suitable for tutorials, annotated examples and projects that benefit from a literate programming approach.
Crycco also supports literate source files, where explanatory Markdown forms the main content and code appears within specially formatted sections. Beyond its basic documentation facilities, the application provides mechanisms for connecting references between files and source symbols. These capabilities make it more useful for documenting collections of related source files rather than isolated examples.
This is free and open source software.
Key Features
- Generates documentation from source code comments and literate programming files.
- Supports side-by-side and single-column documentation layouts.
- Formats explanatory text using Markdown.
- Applies syntax highlighting to source code through configurable templates.
- Processes literate files containing Markdown commentary and indented code sections.
- Can incorporate standalone Markdown documents into a documentation project.
- Supports references between documentation files using wiki-style linking syntax.
- Optional ctags integration resolves references to classes, methods and other source symbols.
- Provides automatic linking to recognised source definitions within generated documentation.
- Supports HTML, Markdown and literate Markdown output modes.
- Customisable themes and templates control documentation presentation.
- Handles unresolved and ambiguous symbol references without creating misleading links.
Website: github.com/ralsina/crycco
Support:
Developer: Roberto Alsina
License: The Lil License v1
Crycco is written in Crystal. Learn Crystal with our recommended free books and free tutorials.
Related Software
| Documentation Generators | |
|---|---|
| JSDoc | API documentation generator for JavaScript |
| Javadoc | Generate API documentation in HTML format |
| Sphinx | Create intelligent and beautiful documentation for Python projects |
| phpDocumentor | Complete documentation solution for PHP |
| Doxygen | Documentation system for C, C++, Java, Python and other languages |
| Docusaurus | Build, deploy and maintain documentation websites |
| mdBook | Create modern online books from Markdown files |
| YARD | Ruby documentation tool |
| Starlight | Documentation website framework |
| Docco | Literate-programming-style documentation generator |
| Natural Docs | Documentation generator that supports 21 different languages |
| Quarto | Scientific and technical publishing system |
| Antora | Modular documentation site generator |
| Crycco | Quick and dirty documentation generator |
| ROBODoc | Documentation tool similar to Javadoc |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.