JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11
  • Score
    100M100P100Q46894F
  • License MIT

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.

Package Exports

  • offline-md-docs
  • offline-md-docs/src/build.js

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

Table of Contents

  1. Features
  2. Quickstart
  3. Running a local dev server
  4. Building the docs
  5. Customization
  6. Roadmap

Features

  • Yields a singular .html file as it's output, that is ready for offline use (0 dependencies)
    • Embeds images as base64 (with caching to avoid duplicates)
    • Embeds your md files
  • Syntax highlighting for code blocks
  • Supports images and folders
  • Supports linking between different pages and headings

Quickstart

  1. Create a new folder and add a config.yaml to it with the following content:
title: My Documentation Title
theme: cyan
  1. Start creating new markdown files in that folder to get your documentation going
  2. Run npx ... to open the live preview of your documentation
  3. Once happy, run npx offline-md-docs build to build your final html file

Running a local dev server

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

npx offline-md-docs start

Building the docs

To build your documentation, run:

npx offline-md-docs build

Customization

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:

---
order: 1
---

Folder Customization Add a metadata.yaml file to your folder, which contains the metadata:

---
order: 1
---

Linking between pages

You can link between different pages by using the following syntax:

[Link to another page](#Core-Concepts/CodeTest)

Where Core-Concepts/CodeTest is the slugified path to the page you want to link to.

You can also link to specific headings within a page by appending ?h=Heading-Name to the URL:

[Link to another page with heading](#Core-Concepts/Understanding-Core-Concepts?h=Kelp-Settings-2)

Where Kelp-Settings-2 is the slugified version of the heading you want to link to.

Roadmap

  • Support dark and light mode (currently only supports dark mode)
  • Support infinite folder nesting (currently only supports folders on the root level)
  • Support phones and make the pages more responsive
  • Switch to async fs functions and process pages in parallel
  • Create documentation page using the tool