Socket
Book a DemoInstallSign in
Socket

mdtome

Package Overview
Dependencies
Maintainers
1
Versions
34
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mdtome

Markdown Tome is a Gitbook clone

0.8.5
latest
Source
npmnpm
Version published
Weekly downloads
37
Maintainers
1
Weekly downloads
 
Created
Source

mdtome

Markdown Tome - A Gitbook clone.

  • Fast
  • Simple
  • Compatible with Gitbook structure(s)
  • Produces optimized builds
  • Creates sitemaps by default
  • Can generate PDFs
  • Google Analytics and Adsense built in by default

Example: https://andersevenrud.github.io/mdtome

Requirements

Node 8.x or later.

Installation

npm install -g mdtome

You can also install this locally in your projects.

Configuration

Create a file named .mdtome

module.exports = {
  input: '.',
  title: 'My Awesome Tome',
  url: 'http://my-website.com'
};

See src/config.js for a full list of options. TODO: Add table here

Regular Gitbook book.json file is also supported, but will not allow you to make any customization.

Usage

The generated output will be in _book/ by default.

CLI

Simply run this command in your project root directory:

mdtome [--input=path] [--output=path] [--pdf=path] [--verbose] [--watch]

Or if you have mdtome as a dependency in your project:

npx mdtome [--input=path] [--output=path] [--pdf=path] [--verbose] [--watch]

Note, use NODE_ENV=production mdtome ... to make an optimized build.

API

const mdtome = require('mdtome');

mdtome({
  /* Configuration options here */
  /* Same as the .mdtome file */
}) // -> Promise

Plugins

module.exports = {
  // Per page render
  render: html => Promise.resolve(html)

  // Template loading
  template => (html, pdf) => Promise.resolve(html)
};

Benchmarks

Using https://github.com/bagder/everything-curl

  • Gitbook: 23.79s user 0.73s system 108% cpu 22.495 total
  • mdtome: 4.18s user 0.18s system 110% cpu 3.952 total

System: i5-4670K + SSD

TODO

  • Generation: Glossary
  • Generation: Languages
  • Plugin: Typed quotes
  • Customization: CSS/JS entry points
  • UI: Highlight links based on scroll

License

MIT

FAQs

Package last updated on 02 Nov 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.