Add readme and license
This commit is contained in:
parent
cfcd2ed6eb
commit
e63425433e
|
@ -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.
|
|
@ -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
|
||||
<!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>
|
||||
```
|
Loading…
Reference in New Issue