https://github.com/kellojo/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.
https://github.com/kellojo/offline-docs

docs documentation documentation-tool embedded markdown offline single-file ssg static-site-generator

Last synced: 9 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/kellojo/offline-docs
• Owner: Kellojo
• License: mit
• Created: 2025-09-14T12:42:16.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-09-21T13:47:17.000Z (9 months ago)
• Last Synced: 2025-09-21T15:06:34.640Z (9 months ago)
• Topics: docs, documentation, documentation-tool, embedded, markdown, offline, single-file, ssg, static-site-generator
• Language: HTML
• Homepage: https://www.npmjs.com/package/offline-md-docs
• Size: 3.72 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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](img/example.png)

## 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](https://kellojo.github.io/Offline-Docs/Offline%20Markdown%20Docs.html#Quickstart).

## 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