A tiny(!) JavaScript clone of Jekyll inspired by RequireJS
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
pages Reorganize files May 10, 2015
templates Tiny bit of cleanup Jun 26, 2015
.nojekyll Tell GitHub not to use Jekyll May 10, 2015
index.html Missed a three leter variable name Jun 26, 2015
marked.js Reorganize files May 10, 2015
readme.md Add demo link May 10, 2015

readme.md

Jerkll

A tiny (30 line) JavaScript clone of Jekyll inspired by RequireJS.

Like Jekyll, you maintain your website as a collection of static markdown files. Like RequireJS, dependencies (templates) are resolved on the fly via http.

No server-side compilation is need. All rendering is done in the browser.

Demo: https://jordaneldredge.com/projects/jerkll/

Is this a terrible idea?

Yes.

Usage

  • Install: Place the index.html and marked.js files in the root of your web path.
  • Create your pages as .md files. In the /pages directoy. /pages/index.md will be your default page.
  • Link to other pages: #path/to/markdown/file.
  • For local development, issue python -m SimpleHTTPServer. Asynchronous loading of files via the file:/// protocol is prohibited.

Format

Pages and templates take the following format:

  ---
  {
     "template": "templates/index.html",
     "name": "Captbaritone"
  }
  ---
  # Hello World

  My name is {{ name }}. Welcome to my home page, please visit my
  [blog](#blog)

A template must include a {{ content }} wild card:

  ---
  {
     "title": "Jerkll"
  }
  ---
  <title>{{ title }}</title>
  <h1>My Home Page</h1>

  <a href='#'>Home</a>
  {{ content }}