cdelorme c1b6ae4dc7 update static library code to be much simpler | há 7 anos atrás | |
---|---|---|
cmd | há 7 anos atrás | |
templates | há 7 anos atrás | |
.gitignore | há 7 anos atrás | |
license | há 7 anos atrás | |
markdown.go | há 7 anos atrás | |
markdown_test.go | há 7 anos atrás | |
readme.md | há 7 anos atrás | |
static.go | há 7 anos atrás | |
static_test.go | há 7 anos atrás | |
templates.go | há 7 anos atrás |
This is a go library written to provide static generation of html from markdown with a template.
The intended function is to make it easy to convert large folders of documentation in bulk to explorable web content or a single-page document for printing as a PDF and redistributing.
The original goal of the project was to learn more about the programming language and tooling.
The design focuses on three key outcomes:
It depends on:
An example template has been provided.
It automates two convenience outputs:
A user-defined template affords you flexibility and control.
A limited subset of variables are provided for your use:
The .Depth
property is used when generating paths to global resources such as javascript, style sheets, and images.
The .Version
property allows you to address cached resources such as javascript, style sheets, and resources javascript may ask for. It is highly efficient as the cache will immediately rebuild using the new version.
The .Nav
is the table-of-contents produced in single-page or "book" mode, and is empty otherwise.
The .Content
is the file contents converted to html, and will have a table of contents automatically prepended to any index.html
file deeper than the root of the output folder.
Any assets hosted on a CDN can be given full paths, and it is recommended to host binary resources (such as images) and any javascript and style sheets there as well.
To import the library:
import "github.com/cdelorme/staticmd"
To install the cli utility:
go get -u github.com/cdelorme/staticmd/...
The ellipses will install all packages below the main path.
In the future I would like to address the following:
page
struct to cleanly separate codeback-to-top
from code
back-to-top
feature can be generated on-load via javascripttitle:
or first header