Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nolze/epoche

A modern, small wiki engine without complexity
https://github.com/nolze/epoche

cms markdown node nodejs self-hosted sqlite sqlite3 svelte wiki wiki-engine

Last synced: 3 months ago
JSON representation

A modern, small wiki engine without complexity

Host: GitHub
URL: https://github.com/nolze/epoche
Owner: nolze
License: mit
Created: 2020-09-09T11:50:23.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-02-21T17:50:17.000Z (almost 3 years ago)
Last Synced: 2024-09-30T01:01:16.015Z (3 months ago)
Topics: cms, markdown, node, nodejs, self-hosted, sqlite, sqlite3, svelte, wiki, wiki-engine
Language: JavaScript
Homepage: https://epoche.org/wiki/Epoche
Size: 1.11 MB
Stars: 16
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Epoche

[![npm version](https://img.shields.io/npm/v/epoche)](https://www.npmjs.com/package/epoche)

[![npm downloads](https://img.shields.io/npm/dm/epoche)](https://www.npmjs.com/package/epoche)

[![CI](https://github.com/nolze/epoche/workflows/CI/badge.svg)](https://github.com/nolze/epoche/actions?query=workflow%3ACI)

A modern, small wiki engine without complexity. **See it in action:** 

## Features

- Powered by Node.js + SQLite3: all you need is `npm`

- Support Markdown with [unified](https://github.com/unifiedjs/unified)

  - [x] 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](https://pm2.keymetrics.io/) (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:** `[]()` (eg. `[foo bar](FooBar)`)

## Todo

- [x] Wiki-style link

- [ ] [Pure ESM package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) (required for the newer unified.js)

- [ ] Syntax highlighting

- [ ] File uploads?

- [ ] Add tests