https://github.com/botic/flusspferd

A static site generator for Ringo
https://github.com/botic/flusspferd

Last synced: about 1 month ago
JSON representation

A static site generator for Ringo

• Host: GitHub
• URL: https://github.com/botic/flusspferd
• Owner: botic
• License: mit
• Created: 2015-02-20T11:05:21.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-18T12:24:56.000Z (over 7 years ago)
• Last Synced: 2023-03-11T07:58:30.045Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flusspferd

Flusspferd is a simple static site generator based RingoJS. It takes markdown files, processes them and uses

reinhardt templates to generate the final HTML.

## Getting started

You can generate a project stub by running flusspferd's

main script with the init parameter:

`ringo main.js init /path/to/emtpy-project/`

A good way to automatically update the output during development is `fswatch`, a cross-platform file change monitor. If you update one of your sources in the `content`, `templates`, or `static` dir, it will notify you about the changes. Here an example:

`fswatch -o /code/example.com/content/ /code/example.com/templates/ /code/example.com/static/ | xargs -n1 -I{} ringo main.js /code/example.com/`

## Convention over configuration

The easiest way to run flusspferd is to generate a project with the folders `content`, `output`, `static` and `templates`.

The `output` folder itself should be empty, the others contain the project's files.

    project

    ├── content

    │   └── index.md

    ├── output

    │   ├── index.html (generated)

    │   └── static (copied)

    │       └── image.png (copied)

    ├── static

    │   └── image.png

    └── templates

        └── base.html

Start the generator with `ringo main.js /path/to/project`.

Flusspferd will scan the `content` folder for markdown files and puts the result into the output folder.

All static files from the `static` folder will be copied to `output`.

You must provide a template named `base.html` in the `template` folder.

This template ist the master for all generated pages and will be rendered providing two properties: `content` and `title`.

If your markdown file starts with an <h1>, this will be the title for the page, otherwise its emtpy.