yelk.js
v1.0.0
Published
Node Jekyll alternative
Readme
Yelk.js
Yelk.js is a Jekyll alternative build with Node.
Local development setup
Install
npm install yelk
Run in development mode
yelk -dev
Development mode serves the site on the fly, generating pages on the fly. Then, you can access the site locally by going to https://localhost:8080 in your web browser.
Build the static site in the build folder
yelk -build
Builds a purely static copy of the site in the build directory.
Deploy the build folder and contents to the gh-pages branch and push updates
yelk -deploy
Project structure
Your yelk.js powered repo has four folders:
/static
Contains static files. e.g. images, js, css, etc. Assets in this directory will be served at root path /.
/templates
Contains the handlebars.js templates.
/content
Contains the files for which pages are built from. The directory structure in this folder directly results in the site structure. Can include the html, handlebars.js templates, markdown, or txt files.
For example:
| Content File Path | Browser URL Path | Static File Path Builds |
| -------------------- | ------------------ | ----------------------------- |
| index.html | / | /index.html |
| blog/index.html | /blog | /blog/index.html |
| blog/post-title.md | /blog/post-title | /blog/post-title/index.html |
| about/index.html | /about | /about/index.html |
| about/people.txt | /about/people | /about/people/index.html |
Meta Header
Content files may optionally contain a meta header. Started with jekyllrb with some customizations.
---
template: post
title: Norfolk.js meetup kickoff
tags: javascript, meetup, norfolk
published: true
excerpt: The kickoff meetup for the Norfolk.js group.
---The only properties that yelk.js uses are the title property and the template property. The title property sets the document title. If the template property isn't set the default template is used. All the values in the header can be used in the handlebars templates.
