ni/README.md

1.1 KiB

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

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

# 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:

# aeropress

Created by Alan Adler

Here is an example of template:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Ichipedia</title>
  </head>
  <body>
    <nav><a href="/">home</a> <a href="/changelog.html">changelog</a></nav>
    {{ template "content" . }}
    <footer>
      <hr>
      <a href="https://ichi.city">
	<img src="https://ichi.city/banner.png" alt="ichi"/>
      </a>
    </footer>
  </body>
</html>