https://github.com/bojand/mdpage
Simple documentation tool
https://github.com/bojand/mdpage
documentation hacktoberfest
Last synced: 7 months ago
JSON representation
Simple documentation tool
- Host: GitHub
- URL: https://github.com/bojand/mdpage
- Owner: bojand
- License: apache-2.0
- Created: 2019-12-31T19:40:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-17T01:07:54.000Z (over 6 years ago)
- Last Synced: 2025-10-11T02:43:48.473Z (9 months ago)
- Topics: documentation, hacktoberfest
- Language: Rust
- Homepage: https://bojand.github.io/mdpage
- Size: 149 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mdpage
> Simple documentation tool
[](https://github.com/bojand/mdpage/actions?workflow=build)
[](LICENSE)
[](https://www.paypal.me/bojandj)
[](https://www.buymeacoffee.com/bojand)
[mdPage](https://github.com/bojand/mdpage) is a minimal, opinionated, command line utility (and [Rust](https://www.rust-lang.org/) crate) for creating single-page HTML documentation from markdown files.
## Demo
The [mdPage documentation](https://bojand.github.io/mdpage) is generated using the `mdpage` CLI tool from markdown source files. There are additional examples listed in the documentation with sources available in the `docs` directory.
## Installation
There are multiple ways to install mdPage.
1. **Binaries**
Binaries are available for download [here](https://github.com/bojand/mdpage/releases). Make sure to put the
path to the binary into your `PATH`.
2. **From Crates.io**
This requires Rust and Cargo to be installed. Once you have installed
Rust, type the following in the terminal:
```
cargo install mdpage
```
This will download and compile mdPage for you, the only thing left to do is
to add the Cargo bin directory to your `PATH`.
## Usage
`mdpage` tool takes a singe argument, the root path directory where all the markdown content is located.
```sh
$ mdpage --help
mdpage 0.1.1
Generate simple documentation
USAGE:
mdpage [FLAGS] [OPTIONS]
FLAGS:
--full-page Generate full page documentation
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-o, --output The output file
--subtitle Subtitle of the document
--title Title of the document
ARGS:
Path for the directory containing data
```
The result of running the tool is always an `index.html` file.
Example workflow:
```sh
$ ls ./examples/basic | sort
page1.md
page2.md
readme.md
$ mdpage ./examples/basic
$ ls ./examples/basic | sort
index.html
page1.md
page2.md
readme.md
$ open index.html
```
## License
Apache-2.0