yellows111
/
yiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
the yellows111 wiki
9 Commits 1 Branch 5 Tags 194 KiB
JavaScript 79.1%
Makefile 13.4%
CSS 7.5%
Go to file
yellows111 f51418b79d 0.1.1: Another Minor Formatting Update 
* monospace now gets same treatment as urls when prefixed with ( or ['s
* Added terminating newline to files that were modified in 0.1.0,
  since i forgot last time
 		2024-05-13 11:40:42 +01:00
.gitignore 0.0.4 - "styling it up" 2024-04-18 11:02:01 +01:00
GNUmakefile 0.0.7 - "now we have sitemaps" 2024-04-22 14:48:59 +01:00
LICENSE 0.0.4 - "styling it up" 2024-04-18 11:02:01 +01:00
README.md 0.1.0: introducing ymake 2024-05-09 12:14:50 +01:00
compile.js 0.1.1: Another Minor Formatting Update 2024-05-13 11:40:42 +01:00
package-lock.json 0.1.1: Another Minor Formatting Update 2024-05-13 11:40:42 +01:00
package.json 0.1.1: Another Minor Formatting Update 2024-05-13 11:40:42 +01:00
sitemap-gen.js 0.1.1: Another Minor Formatting Update 2024-05-13 11:40:42 +01:00
yiki.css 0.0.4 - "styling it up" 2024-04-18 11:02:01 +01:00
ymake.js 0.1.1: Another Minor Formatting Update 2024-05-13 11:40:42 +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

node ymake, set options using export commands.

An alternative makefile for GNU make is avaliable if it is prefered.

Either way, you'll want to write Markdown (*.md) files to the docs (which is the default SRC_DIRS) directory.

Afterwards, check the build (BUILD_DIR) directory for the .html files.

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

node compile source.md target.htm

Options

SRC_DIRS Specify the directory which yiki compiles files from.

ymake: export SRC_DIRS="./input"

GMake: gmake SRC_DIRS="./input"

BUILD_DIR Specify the directory which yiki compiles files into.

ymake: export BUILD_DIR="./output"

GMake: gmake BUILD_DIR="./output"

WIKINAME Specify what the "A new yiki!" text should be replaced with.

ymake: export WIKINAME="I love options!"

GMake: gmake WIKINAME="I love options!"

VPREFIX Specify the virtual root of that the default template links to for the yiki.css and the index.html files.

ymake: export VPREFIX="/yiki/"

GMake: gmake VPREFIX:="/yiki/"

DOMAIN Specifiy the domain name that your sitemap.xml links to.

ymake: export DOMAIN="example.com"

GMake: gmake DOMAIN:="example.com"

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.