https://github.com/captbaritone/jerkll

A tiny(!) JavaScript clone of Jekyll inspired by RequireJS
https://github.com/captbaritone/jerkll

Last synced: 10 months ago
JSON representation

A tiny(!) JavaScript clone of Jekyll inspired by RequireJS

• Host: GitHub
• URL: https://github.com/captbaritone/jerkll
• Owner: captbaritone
• Created: 2015-05-10T00:11:16.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-08-24T23:28:11.000Z (over 10 years ago)
• Last Synced: 2025-01-10T23:32:09.712Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://jordaneldredge.com/projects/jerkll/
• Size: 262 KB
• Stars: 19
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Jerkll

A tiny ([30 line](https://github.com/captbaritone/jerkll/blob/master/index.html))

JavaScript clone of [Jekyll](http://jekyllrb.com/) inspired by

[RequireJS](http://requirejs.org/).

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 }}

      
My Home Page


      Home

      {{ content }}