/sancho

Github Pages Puncher

Primary LanguageRuby

title: Sancho Readme keywords:

  • ruby
  • github-pages-generator ...

Overview

Sancho is Github Pages generator for Github Repositories or private pages. It supposed that your site will be placed in docs directory, under docs git branch.

For rendering HTML Sancho utilizes Pandoc, and it is supposed that your site pages will be written in Markdown or Pandoc Markdown.

By default configuration (sancho.yml) your site will consists of just two files README.md and CHANGELOG.md.

It will also create robots.txt and sitemap.xml files. When you don't need them - just remove *.erb inside _layouts directory.

Installation

Run

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

Modify Rakefile adding

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

Install pandoc

Usage

Basics

  1. Commit your repo changes!
  2. Run $ git checkout docs
  3. Run $ rake sancho:init
  4. Modify sancho.yml for pages and _layouts/header.md for navbar
  5. Run $ rake sancho:generate
  6. Run $ git push -u origin docs

Template

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

Links