Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 1.3 KB

README.md

File metadata and controls

58 lines (39 loc) · 1.3 KB

Epoche

npm version npm downloads CI

A modern, small wiki engine without complexity. See it in action: https://epoche.org/wiki/Epoche

Features

  • Powered by Node.js + SQLite3: all you need is npm
  • Support Markdown with unified
    • Math (with MathJax)

Install

npm install -g epoche

Usage

Set up:

epoche init ./epoche.db  # create & init database

Start wiki:

epoche start --db ./epoche.db --port 3000

With pm2 (daemonize):

pm2 start epoche -- start --db ./epoche.db --port 3000

Using Nginx, Apache, or the like is recommended for load balancing etc.

Help:

epoche help

Extra syntax

  • Wiki links: [<link text>](<page name>) (eg. [foo bar](FooBar))

Todo

  • Wiki-style link
  • Pure ESM package (required for the newer unified.js)
  • Syntax highlighting
  • File uploads?
  • Add tests