https://github.com/creativcoder/rocco

rocco is a Rust library to generate literate programming style html pages. See `cargo docco` https://github.com/creativcoder/cargo-docco project for more details.
https://github.com/creativcoder/rocco

crates docco languages rust-lang rust-language rust-library

Last synced: 3 months ago
JSON representation

rocco is a Rust library to generate literate programming style html pages. See `cargo docco` https://github.com/creativcoder/cargo-docco project for more details.

• Host: GitHub
• URL: https://github.com/creativcoder/rocco
• Owner: creativcoder
• License: apache-2.0
• Created: 2020-11-06T06:07:09.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-02T08:19:21.000Z (about 2 years ago)
• Last Synced: 2024-09-29T20:42:15.821Z (3 months ago)
• Topics: crates, docco, languages, rust-lang, rust-language, rust-library
• Language: Python
• Homepage:
• Size: 50.8 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

[![Actions Status](https://github.com/creativcoder/rocco/workflows/ci/badge.svg)](https://github.com/creativcoder/rocco/actions)

[![crates.io](https://img.shields.io/crates/v/rocco.svg)](https://crates.io/crates/rocco)

[![docs.rs](https://docs.rs/rocco/badge.svg)](https://docs.rs/rocco/)

[![license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-MIT)

[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-APACHE)

# Rocco

Rocco (library) is a Rust port of Jash Kenas' [docco](https://github.com/jashkenas/docco). A way to achieve [literate programming](http://www.literateprogramming.com/).

## Overview

Rocco is primarily in use by [cargo-docco](https://github.com/creativcoder/cargo-docco).

It provides APIs to generate documentation from literate source files.

Literate programming style docs are supported only as line comments. Block comments are usually not supported (for keeping implementation concise and simple), as in the [original](http://ashkenas.com/docco) implementation.

## Supported languages

See [`languages.json`](src/assets/languages.json) for supported languages. Feel free to submit PRs to support more languages.

## Support



[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/P5P71YZ0L)

## License

Dual licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.