From e63425433e9588a504fbcf2a861045eb43da44ec Mon Sep 17 00:00:00 2001 From: m15o Date: Tue, 2 Nov 2021 06:39:04 +0100 Subject: [PATCH] Add readme and license --- LICENSE | 21 +++++++++++++++++++++ README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bd257a8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) m15o + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e0cebf1 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# ni + +Ni is a static wiki generator. It allows you to write files that reference each other, and to generate an html output that includes links and back links. + +## How to run + +```shell +ni src dest template +``` + +Where: +* src: source folder containing `.gmi` files +* dest: destination folder for `.html` files +* template: html template file + +## How to use + +In `src` folder, create files that end with `.gmi`. Use `[[]]` to reference other files in them. For example: + +in `coffee.gmi` +```markdown +# coffee + +A popular machine is the [[aeropress]]. +``` + +The above automatically create a link in the generated .html file, but it requires `aeropress.gmi` to be created: + +```markdown +# aeropress + +Created by Alan Adler +``` + +Here is an example of template: +```html + + + + + Ichipedia + + + + {{ template "content" . }} + + + +``` \ No newline at end of file