This new Pulsar Documentation website utilizes eleventy
.
This project superseedes previous efforts utilizing sloth
as it's been determined that eleventy
is the more mature implementation of the same exact goals of sloth
and it makes the most sense to utilize a framework that's more mature, and requires significantly less maintenance.
npm install
git submodule init
git submodule update
npm run build
: Builds the sitenpm run serve
: Creates a live version of the site at :8080
npm run build:debug
: Builds the site with debug flags setnpm run serve:debug
: Creates a live server with debug flags setWhile obviously nearly all text should be redone, there are also some technical changes that should occur:
Switch uses of <kdb>Ctrl</kdb>
to [[Ctrl]]
Switch links with @images
to /img
The biggest aspects of this that still have to be completed:
pulsardoc
to support Coffee and enable coffee based repos to documentHere will be the very short, non-complete style guide:
If linking to a resource on GitHub, such as the language-git
package, ensure to never include the branch.
By default if you copy paste the link to the language-git
package it will look like:
https://github.com/pulsar-edit/pulsar/tree/master/packages/language-git
But in the rare event the branch name never changes, we can make simple changes now to avoid stress later, by replacing the master
here with HEAD
, such as:
https://github.com/pulsar-edit/pulsar/tree/HEAD/packages/language-git
Within each page of markdown you should never include an <h1>
heading level (#
) always start on <h2>
(##
) as the title of the page is extracted and used as a level one heading in all cases.
For simplicity, and ability to find and replace links in the future, all links between pages should be from the root of the website.
Meaning start all links with /
and direct to the page you are attempting to link to.
A safe exception to this rule is for anchor links on the same page, as those can just be the anchor itself.
But for all other links, please do follow this rule and do not use relative links.
Examples: When linking to /example/sub/page
from /example/sub/hello
/example/sub/page
../page