https://github.com/derhuerst/technical-docs-cli

Render technical markdown docs as HTML. Opinionated.
https://github.com/derhuerst/technical-docs-cli

documentation markdown md

Last synced: 2 months ago
JSON representation

Render technical markdown docs as HTML. Opinionated.

• Host: GitHub
• URL: https://github.com/derhuerst/technical-docs-cli
• Owner: derhuerst
• License: isc
• Created: 2020-10-02T15:18:03.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-04-19T18:34:31.000Z (about 3 years ago)
• Last Synced: 2025-09-29T06:42:55.147Z (9 months ago)
• Topics: documentation, markdown, md
• Language: JavaScript
• Homepage: https://github.com/derhuerst/technical-docs-cli#derhuersttechnical-docs-cli
• Size: 36.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

          
# @derhuerst/technical-docs-cli

**Render technical markdown docs as HTML.** Opinionated.

[![npm version](https://img.shields.io/npm/v/@derhuerst/technical-docs-cli.svg)](https://www.npmjs.com/package/@derhuerst/technical-docs-cli)

[![build status](https://api.travis-ci.org/derhuerst/@derhuerst/technical-docs-cli.svg?branch=master)](https://travis-ci.org/derhuerst/@derhuerst/technical-docs-cli)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/@derhuerst/technical-docs-cli.svg)

![minimum Node.js version](https://img.shields.io/node/v/@derhuerst/technical-docs-cli.svg)

[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)

[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)

## Installation

```shell

npm install @derhuerst/technical-docs-cli

```

## Usage

```

Usage:

    build-technical-doc [options]

Options:

    --syntax-stylesheet 

        Print a syntax highlighting stylesheet from highlight.js.

    --syntax-stylesheet-url

        Link to the syntax highlighting stylesheet. Default: ./syntax.css

    --change-md-links

        Change `*.md` links to `.html`. Default: true

Examples:

    cat readme.md | build-technical-doc >index.html

```