Skip to content

nvoynov/sancho

Repository files navigation


title: Sancho Readme keywords:

  • ruby
  • github-pages-generator ...

Sancho is static site generator for Github Pages. Site content should to be written in Markdown or Pandoc Markdown. And it will be rendered with Pandoc

Installation

Run

$ bundle add sancho --git https://github.com/nvoynov/sancho.git

Require it in the Rakefile

require "sancho"
source, folders = Sancho.tasks
Rake.application.rake_require source, folders

Install pandoc

Usage

To initialize site content, run the initialization task

$ rake sancho:init

Configure the site content by customizing sancho.yml

Render HTML content from markdown sources

$ rake sancho:docs

Serve it locally by

$ rake sancho:serve

[Template]{.underline}

You can provide your own HTML template by placing _layouts/template.html file. Read Pandoc Templates section for details.

Links