https://github.com/makiwiki/maki

A Dropbox-based Personal Wiki Engine written in JavaScript (Mithril.js)
https://github.com/makiwiki/maki

wiki wiki-engine

Last synced: 2 months ago
JSON representation

A Dropbox-based Personal Wiki Engine written in JavaScript (Mithril.js)

• Host: GitHub
• URL: https://github.com/makiwiki/maki
• Owner: makiwiki
• License: gpl-3.0
• Created: 2016-07-03T11:30:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T21:10:08.000Z (about 2 years ago)
• Last Synced: 2024-04-13T21:56:57.770Z (9 months ago)
• Topics: wiki, wiki-engine
• Language: JavaScript
• Homepage: https://makiwiki.github.io/
• Size: 2.57 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starred - makiwiki/maki - A Dropbox-based Personal Wiki Engine written in JavaScript (Mithril.js) (others)

README

        
# Maki

[![Dependencies][deps-image]][deps-url] [![Build Status][ci-image]][ci-url]

Maki is a Dropbox-based personal wiki engine.

## Table of Contents

* [Features](#features)

* [Using a Maki wiki](#using-a-maki-wiki)

* [Contributing](#contributing)

* [Todo](#todo)

## Features

* Private in principle

* Distraction-free: integrated with cloud storage

* Everything runs on client-side

* Supports Markdown

* Math rendering with KaTeX

* Sub pages

## Using a Maki wiki

* 

* or set up by your own (see below)

### Installation

1. [Create app](https://www.dropbox.com/developers/apps) for Maki in your Dropbox account.

2. Place `dist/*` files into your webspace, such as GitHub Pages.

3. Edit `CLIENT_ID` and `REDIRECT_URI` in `index.html`.

4. That's all!

## Contributing

TBA

## Todo

* Modular architecture

  * Support other cloud storage services

  * Support plugins

  * Support other markup languages?

* Add update notices

[deps-image]: https://david-dm.org/makiwiki/maki.svg

[deps-url]: https://david-dm.org/makiwiki/maki

[ci-image]: https://travis-ci.org/makiwiki/maki.svg?branch=master

[ci-url]: https://travis-ci.org/makiwiki/maki