pkwiki
v0.3.0
Published
This is a node package to assist in creating a simple static website from markdown pages.
Downloads
6
Readme
PKWiki
This is a node package to assist in creating a simple static website from markdown pages.
Usage
You may choose to install PKWiki globally:
npm install -g pkwiki
pkwiki <input folder> <output folder>Or locally into a node project:
npm install pkwiki
npx pkwiki <input folder> <output folder>It also supports a --watch parameter, which will cause it to monitor <output folder>
for changes and automatically recompile.
Either way, the <input folder> should contain the following things:
_template.htmlto define your basic layout. Refer to below for the required format.- Any other
_<something>.htmlinclude files. Refer to below for the required format. - A series of Markdown files with your content. Refer to below for the required format.
- Special pages with specific purposes. Refer below etc etc you get the idea.
- Any additional resources (stylesheets, images, etc) to be copied to the output
Refer to the test folder in this package for a working example.
Anatomy of _template.html
This file should be a plain HTML file with all the requisite markup (<html>, <head>, <body>, etc).
This file will be used as the base for every page in the site. You may wish to add a navigation bar,
branding, styling, etc.
It can (and probably should) contain a few placeholders:
{{title}}this will be replaced with the title of the page. Eg,Cats{{prefixedtitle}}this is the same as{{title}}but includes a dash in front. Eg,- Cats. Meant for the<title>tag.{{body}}this will be replaced with the rendered content of the page. Eg,Cats are cute fuzzy creatures typically kept as pets ...
This file will not be copied to the output directly.
Anatomy of _.html
Other underscore-prefixed files are used as includes in your pages. Inspite of the extension, these will be parsed for markdown, allowing for recursively including includes. As such, refer to the main page section for more details.
One aspect that is only applicable to includes, however, is the parameter replacement. You may include
{{#1}}, {{#2}}, tags as placeholders in your content. These will be replaced with the first, second, etc
parmaters in the include. Eg, given the include command {{foo|bar|baz}}, parameter 1 is bar and 2 is baz.
You may include a default for the replacements, in case the parameter is not passed. This looks like: {{#1|default}}.
So, assuming the include command was {{foo|bar}}, then {{#1|quux}} will become bar, while {{#2|qaaz}} will
become qaaz.
Anatomy of a markdown page.
Markdown is largely CommonMark compatible, So, you can start by writing your text with Markdown. Additionally, the following extensions are provided:
Adding a title tag
Somewhere in your document (probably at the top), you may include a title tag that looks like this:
#title My Awesome TitleThis will set the title for the page to My Awesome Title. This is not rendered by default, but you may
include the {{title}} placeholder in your template to include it.
Linking to other pages
Links are defined by double square brackets:
[[Foo Bar]]
[[Foo Bar|the fooest of bars]]The first syntax is just a plain link to the foo-bar page, with a label of Foo Bar. The second one
includes a custom label of the fooest of bars, but links to the same place.
Note that when resolving a link, the destination text has all special (i.e, not letter, digit or underscore)
characters replaced with dashes, and then the whole thing is lowercased. So, [[Foo Bar]], [[FOO BAR]] and
[[foo-bar]] are all equivalent, but [[FooBar]] is not.
It is possible to include an anchor:
[[Foo Bar#Baz]]
[[Foo Bar#Baz|the bazziest of foobars]]These will be treated as links to foo-bar, just as before, but also include an anchor.
Lastly, if a link points to a page that doesn't exist, the link will still be rendered, but it will
have a class of broken assigned to it. You may wish to style it differently.
For example:
[[Not a real page]]Becomes:
<a href="not-a-real-page.html" class="broken">Not a real page</a>Includes
You will likely want to reuse some formatting/markup in different places. To do this, you can factor out your common markup into include files (See above on details how to do this), and then include them:
Given _awesome.html template with the following contents:
<blink>{{#1}}</blink>You might use this on a page like so:
Check it out: {{awesome|Blinky blinky hole}}This will render as:
Check it out: <blink>Blinky blinky hole</blink>You may recursively include templates, but don't create circular references, this will cause generation to fail.
Table of Contents
You could manually create a table of contents, or you can let PKWiki do it for you.
#toc
#toc 2This will look for headings in the page (eg ## Blah) and construct a simple table of contents. This process
is a bit involved, but for most cases this will work fine.
By default, the table of contents will only contain the highest priority headers (eg, h1) and ignore
anything lower. If the highest priority is h4, then that will be included, but h5 will not.
However, if you pass a number, then it will include anything of that priority or higher. For example, #toc 3
will include all h1, h2 and h3 headings. Note that this is not dynamic: If there are only h4 headings
then #toc 3 will generate nothing.
The produced table of contents will have the class table-of-contents for styling purposes.
Example:
#toc 2
# Foo
## Bar
### Baz
## Quux
# Qaaz
## BillWill produce the equivalent of this table of contents:
1. Foo
1. Bar
2. Quux
2. Qaaz
1. BillSpecial pages
Some pages have a special purpose. They can be used as regular pages too, if you wish, but it is important to know they also serve a special function.
404.md
If this page exists, then any broken links will be modified to point to this page instead. The link will still render the way it does normally, and will still be marked as broken, but it will direct the user to this page instead of going to the non-existant page.