https://github.com/redhat-documentation/newdoc

The newdoc tool generates files formatted with AsciiDoc, which are used in Red Hat documentation.
https://github.com/redhat-documentation/newdoc

documentation documentation-generator documentation-tool rust

Last synced: 14 days ago
JSON representation

The newdoc tool generates files formatted with AsciiDoc, which are used in Red Hat documentation.

• Host: GitHub
• URL: https://github.com/redhat-documentation/newdoc
• Owner: redhat-documentation
• License: gpl-3.0
• Created: 2020-06-15T16:50:09.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-29T13:47:30.000Z (3 months ago)
• Last Synced: 2024-10-29T08:26:29.179Z (16 days ago)
• Topics: documentation, documentation-generator, documentation-tool, rust
• Language: Rust
• Homepage:
• Size: 527 KB
• Stars: 24
• Watchers: 4
• Forks: 9
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The newdoc tool

[![Crates.io](https://img.shields.io/crates/v/newdoc)](https://crates.io/crates/newdoc)

[![Crates.io](https://img.shields.io/crates/d/newdoc)](https://crates.io/crates/newdoc)

[![Crates.io](https://img.shields.io/crates/l/newdoc)](https://crates.io/crates/newdoc)

[![Rust tests](https://github.com/redhat-documentation/newdoc/actions/workflows/rust-test.yml/badge.svg)](https://github.com/redhat-documentation/newdoc/actions/workflows/rust-test.yml)

[![dependency status](https://deps.rs/repo/github/redhat-documentation/newdoc/status.svg)](https://deps.rs/repo/github/redhat-documentation/newdoc)

[![Copr build](https://copr.fedorainfracloud.org/coprs/mmuehlfeldrh/newdoc-rs/package/newdoc/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/mmuehlfeldrh/newdoc-rs/package/newdoc/)

The `newdoc` tool generates pre-populated module and assembly files formatted with AsciiDoc, which are used in Red Hat and Fedora documentation. The generated files follow the Modular Documentation guidelines: .

## Using newdoc

See the full documentation at [Using newdoc](https://redhat-documentation.github.io/newdoc/).

## Release notes

You can find a brief change log in the [CHANGELOG.md](CHANGELOG.md) file.