Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kapouer/marked-man
markdown to roff wrapper around marked
https://github.com/kapouer/marked-man
Last synced: 21 days ago
JSON representation
markdown to roff wrapper around marked
- Host: GitHub
- URL: https://github.com/kapouer/marked-man
- Owner: kapouer
- License: other
- Created: 2013-05-06T22:08:39.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T11:38:08.000Z (7 months ago)
- Last Synced: 2024-10-15T19:45:38.795Z (24 days ago)
- Language: Roff
- Homepage:
- Size: 443 KB
- Stars: 76
- Watchers: 4
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - kapouer/marked-man - markdown to roff wrapper around marked (others)
README
marked-man(1) -- markdown to roff
=================================
SYNOPSIS
--------
```bash
marked-man README.md > doc/foo.1
# works too with stdin
cat README.md | marked-man --version 1.0 | man /dev/stdin
```
See also [marked documentation](https://marked.js.org/).
DESCRIPTION
-----------
`marked-man` wraps `marked` to extend it with groff output support in order to
create Unix manual pages for use with `man`.
It follows the `ronn` markdown level-1 header format:
# name(section) -- short description
which populates the *HEADER* section, and the *NAME* section (if none is already written) of the manpage.
OPTIONS
-------
`marked-man` is a `marked` CLI extension, meaning options can be passed directly to marked.
The `--breaks` option, which retains intra-paragraph line breaks, is now true by default. Use `--no-breaks` to disable it.
`marked-man` adds some options to `marked`'s existing options, to be able to override the header/footer of generated man pages.
* `--name `
Optional, overrides `name` in ronn header.
* `--section `
Optional, overrides `section` in ronn header. Defaults to 1.
* `--description `
Optional, overrides `description` in ronn header.
* `--version `
The version shown in the manpage footer.
Optional, when omitted, defaults to the target node module version, or empty.
* `--manual `
The manual-group name shown in the manpage header.
Optional, when omitted, man displays a value matching the section.
* `--date `
The date shown in the manpage header.
Optional, defaults to now.
Must be acceptable to `new Date(string or timestamp)`.
Honors `SOURCE_DATE_EPOCH` environment variable for reproducible builds.
INSTALLATION
------------
See your node package manager manual...
For example:
```bash
npx marked-man simple.md
```
EXAMPLE
-------
To view this README as a man page, run something like the following:
```bash
marked-man README.md | man /dev/stdin
```
AS MARKED EXTENSION
-------------------
```js
import markedMan from 'marked-man';
import marked from 'marked';
marked.use(markedMan);
```
SEE ALSO
--------
[Ronn](https://github.com/rtomayko/ronn)
[Ronn-NG](https://github.com/apjanke/ronn-ng)
[groff](https://man.cx/groff_man(7))
REPORTING BUGS
--------------
See [marked-man repository](https://github.com/kapouer/marked-man).