https://github.com/chambln/red

red – static site generator
https://github.com/chambln/red

makefile pandoc sass static-site-generator

Last synced: about 1 year ago
JSON representation

red – static site generator

• Host: GitHub
• URL: https://github.com/chambln/red
• Owner: chambln
• License: unlicense
• Created: 2019-07-16T04:07:05.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-13T16:49:46.000Z (almost 5 years ago)
• Last Synced: 2025-04-08T14:53:00.214Z (about 1 year ago)
• Topics: makefile, pandoc, sass, static-site-generator
• Language: HTML
• Homepage: https://cosine.blue/red/
• Size: 35.2 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

          
# red – static site generator

This is really just a makefile for turning Markdown and Sass into HTML

and CSS to produce a simple static blog.

There are no scripts or binaries.

A demo of the generated site template is available at .

A brief summary of the Makefile is this:

    src/*.md         →  www/*.html

    src/posts/*.md   →  www/*.html + www/index.html

    src/main.sass    →  www/main.css

    src/header.html     Prepended to every page

    src/footer.html     Appended to every page

Posts are automatically listed in a section appended to the index page

(`src/index.md → index.html`).

The list is sorted alphabetically, so if you name your posts in the

form `YYYY-MM-DD-*.md`, they will be listed in chronological order.

## Dependencies

GNU Make is required.

To build the HTML pages, you need Pandoc.

To build the style sheet, you need a Sass preprocessor such as `sassc`

(edit `Makefile` to use another implementation).

## Usage

Edit and create files within the `src/` directory to determine the

site's content.  Then build:

    make

You can enter

    make clean

to remove all the files that were generated by `make`.

If you modify the `rsync` command in the `deploy` task in the

`Makefile`, you can deploy the generated site to a webserver by running

    make deploy

## See also

A few similar tools I've seen are [bake][1], [pdsite][2], and

[tundra.sh][3].

[1]: https://github.com/fcanas/bake

[2]: http://pdsite.org

[3]: https://frainfreeze.github.io/tundra