# 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: <https://redhat-documentation.github.io/modular-docs/>.

## 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.