wikity

Wikity

Wikity is a tool that allows you to use Wikitext (used by Wikipedia, Fandom, etc) to create pages, for use in build tools such as Eleventy.

Install

Wikity is available on npm.

Local install	Global install
npm install wikity	npm install -g wikity

API

• wikity.compile(directory?: string, options?: object)
  • Compile Wikitext files into HTML. Find outputted files in folder wikity-out/.
  • directory?: string
    • The folder to compile (default: ., the current directory).
  • options?: object
    • eleventy?: boolean
      • Whether front matter will be added to the outputted HTML for Eleventy to read (default: false).
    • defaultStyles?: boolean
      • Whether to use default wiki styling (default: true).
    • customStyles?: string
      • Custom CSS to style the wiki pages (default: '').

Calling wikity() will compile all .wiki files into their corresponding .html versions. Outputted files are located in the wikity-out/ directory.

const wikity = require('wikity');
wikity.compile(); // compile all .wiki files inside this directory

Use Wikity along with Eleventy to compile your wiki files during the build process:

// .eleventy.js (eleventy's configuration file)
const wikity = require('wikity');
wikity.compile('.', { eleventy: true });

Usage

Use Wikitext to create your pages.

Any wiki templates (called using {{template name}}) must be inside the templates/ folder.

Wiki markup

Markup	Preview
'''bold'''	bold
''italic''	italic
'''''bold italic'''''	bold italic
``code``	code
```code block```	code block
= heading =	heading
== subheading ==	subheading
*bulleted	bulleted
**sub-bulleted	sub-bulleted
#numbered	numbered
##sub-numbered	sub-numbered
;term	term
:definition	definition
[[internal link]]	internal link
[[link|display text]]	display text
[external-link]	[1]
[external-link display text]	display text
{{name}}	(contents of templates/name.wiki)
{{name|arg=val}}	(ditto but {{{arg}}} is set to 'val')
{{{arg}}}	(value given by template)
{{{arg|default val}}}	(ditto but with default val if unset)
{{#if:non-empty-string|text}}	text
{{#ifeq:1|2|true|false}}	false
{{#vardefine:varname|text}}	(saved to memory)
{{#var:varname}}	text (from memory)
{{#var:varname|default val}}	(ditto but with default val if unset)
<ref>Text</ref>	[1]
{{reflist}}	1. ↑ Text

Changelog

1.0.0

2021-03-27

• Added compile() function and CLI command to compile wikitext into HTML.
• Added parse() function to parse raw wikitext input.