Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (offline-md-docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Offline-Docs

A simple Node.js package that you can use to create offline product documentation using Markdown. The tool embeds all content into a single output file.

Example Docs Page

Features:

Embedds images as base64
Embedds your md files
Yields a singular .html file as it's output, that is ready for offline use

Quickstart

Create a new folder and add a config.yaml to it with the following content:

title: My Documentation Title
theme: cyan

Start creating new markdown files in that folder to get your documentation going
Run npx ... to open the live preview of your documentation
Once happy, run npx offline-md-docs build to build your final html file

Running a loal dev server

To run a local dev server, which shows you a live preview of your docs, run:

npx offline-md-docs start

Theming

The builder uses Pico CSS under the hood, which allows you to customize the color by providing a predefined scheme, that pico provides. You can find an overview over all available color schemes here: https://picocss.com/docs/version-picker

Custom Sort Order

Entries (either folders or md files) can have a custom order assigned as follows:

Markdown Files Put this yaml metadata at the top of your file: ```yaml

order: 1


**Folder Customization**
Add a metadata.yaml file to your folder, which contains the metadata:
```yaml
---
order: 1
---