JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12
  • Score
    100M100P100Q46760F
  • 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

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 embedding images
  • Supports folders to organize your docs
  • Supports linking between different pages and headings

View Documentation & Demo

You can view the documentation for this project here.

Roadmap

  • Support dark and light mode (currently only supports dark mode)
  • Support infinite folder nesting (currently only supports folders on the root level)
  • Switch to async fs functions and process pages in parallel
  • Init script