# ultrawiki

> A lightweight MediaWiki alternative

Latest version **0.3.1** (published 2016-08-11) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install ultrawiki
pnpm add ultrawiki
yarn add ultrawiki
bun add ultrawiki
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2016-08-11 |
| First published | 2016-08-11 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | Alex Bates |
| Maintainers | nanalan |
| Keywords | wiki, wikipedia, mediawiki, lightweight, docs, documentation |

## Links

- npm: https://www.npmjs.com/package/ultrawiki
- Repository: https://github.com/nanalan/ultrawiki
- Homepage: https://github.com/nanalan/ultrawiki#readme
- Issues: https://github.com/nanalan/ultrawiki/issues
- npm.io page: https://npm.io/package/ultrawiki

## Dependencies (5)

- [mime](https://npm.io/package/mime.md) ^1.3.4
- [mustache](https://npm.io/package/mustache.md) ^2.2.1
- [languages](https://npm.io/package/languages.md) ^0.1.3
- [titlecase](https://npm.io/package/titlecase.md) ^1.1.2
- [markdown-it](https://npm.io/package/markdown-it.md) ^7.0.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.3.1 (latest) — 2016-08-11
- 0.3.0 — 2016-08-11
- 0.2.0 — 2016-08-11
- 0.1.0 — 2016-08-11

## README

# UltraWiki
> A lightweight [MediaWiki](https://github.com/wikimedia/mediawiki) alternative written in Node.js.

## Installation
**The easy way** using `bash` (Linux / Mac):
```sh
$ cd my-awesome-wiki
$ echo 'Installing UltraWiki...' && if [[ ! -f package.json ]]; then echo '{ "private":true }' >> package.json; fi; npm install --save ultrawiki ultrawiki-skin-default express > /dev/null && mkdir wiki && curl -fsSL https://github.com/nanalan/ultrawiki/raw/master/example.js >> wiki.js && perl -pi -e "s/\'\.\/lib\/ultra\'/\'ultrawiki\'/g" wiki.js && mkdir wiki/en && echo '# Welcome to [My Wiki](/)!' >> wiki/en/welcome.md && node wiki.js
# visit http://localhost:9999 in a web browser
```

**The hard way** using `manual labor` (Windows):  
- Open up a folder (say, `my-awesome-wiki`) in `Files`, `Finder`, or `My Documents`
- Make a `package.json` file
- In `Command Prompt` or `Terminal`, navigate to that folder and run `npm install --save ultrawiki ultrawiki-skin-default express`
- Copy [this file](https://raw.githubusercontent.com/nanalan/ultrawiki/master/example.js) into `wiki.js`
- Make a folder, `wiki`, and put another folder, `en`, inside it
- Inside `wiki/en`, create `welcome.md` and put "Hello"
- Replace "./lib/ultra" in `wiki.js` with "ultrawiki" (near the top)
- Run `node wiki.js`
- Visit [this page](http:/localhost:9999) and **profit**!

---
_Source: https://npm.io/package/ultrawiki · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._