Add example folder

Author: Nixinova

example/.eleventy.js

@@ -0,0 +1,13 @@
+const wikity = require('wikity');
+
+module.exports = function (eleventyConfig) {
+    const wikityOptions = {
+        eleventy: true,
+        templatesFolder: 'templates',
+        imagesFolder: 'images',
+        outputFolder: 'wikity-out/',
+    };
+    const wikityPlugin = () => wikity.compile('src', wikityOptions);
+    eleventyConfig.addPlugin(wikityPlugin);
+    eleventyConfig.addPassthroughCopy({ 'src/images': 'wiki/images' });
+}

example/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+_site/
+wikity-out/

example/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "my_wiki",
+  "scripts": {
+    "build": "eleventy",
+    "dev": "eleventy --watch --serve"
+  },
+  "dependencies": {
+    "@11ty/eleventy": "^3.0.0",
+    "wikity": "^1.3.5"
+  }
+}

example/src/Index.wiki

@@ -0,0 +1,5 @@
+{{Header}}
+
+= Index Page =
+
+Welcome to the [[File:diamond.png|10px]] wiki.

example/src/images/diamond.png

@@ -0,0 +1,3 @@
+<div style="border: 1px solid gray;">
+'''Header Content'''
+</div>

example/src/templates/Header.wiki

@@ -8,6 +8,10 @@
 
 This package comes with built-in support for compilation using [Eleventy](https://11ty.dev).
 
+## Exemplar
+
+See the `example` folder for a template on making your own wiki site!
+
 ## Install
 
 Wikity is available [on npm](https://www.npmjs.com/package/wikity).