yellows111
/
yiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
the yellows111 wiki
1 Commit 1 Branch 3 Tags 172 KiB
JavaScript 78.4%
Makefile 13.9%
CSS 7.7%
Go to file
yellows111 748a536ae2 Initial commit 
It mostly works.
 		2024-04-16 14:41:10 +01:00
.gitignore Initial commit 2024-04-16 14:41:10 +01:00
GNUmakefile Initial commit 2024-04-16 14:41:10 +01:00
LICENSE Initial commit 2024-04-16 14:41:10 +01:00
README.md Initial commit 2024-04-16 14:41:10 +01:00
compile.js Initial commit 2024-04-16 14:41:10 +01:00
package-lock.json Initial commit 2024-04-16 14:41:10 +01:00
package.json Initial commit 2024-04-16 14:41:10 +01:00
yiki.css Initial commit 2024-04-16 14:41:10 +01:00

README.md

yiki - the yellows111 "wiki"

Takes a bunch of Markdown (*.md) files (default is from docs), and renders to HTML with preserved directory paths.

Features

  • Table of Contents on every page.
  • Preserved directory paths.
  • All headers can be jumped to.

Motivation

Just felt like writing it so I could write markdown instead of working with HTML syntax rules for my documentation/research archive.

Licensing

MIT. Review the LICENSE file if required.

How to use

You need a copy of GNU make (GPL-3 licensed software).

Use the gmake (or if it's the system makefile parser, make) command after writing Markdown (*.md) files to the docs directory.

Afterwards, check the build directory for the .html files.

Otherwise, if you just want to use yiki to render one file:

node compile source.md target.htm

Contributing

I request (but not require) that you modify files without Carriage Returns, and to terminate new or modified files with a Line Feed character.