Skip to content

gvwilson/mccole

Repository files navigation

McCole

A tool for building very simple static websites. All of the material is available under an open license, and contributions through our GitHub repository are welcome: please see the contributors guide for instructions. All contributors are required to respect our Code of Conduct.

  1. pip install mccole to install.
  2. mccole install to copy the following tools into the current directory:
    • static/page.css: styling for regular pages
    • static/slides.css: styling for slides
    • static/slides.js: JavaScript to make slides interactive
    • templates/page.html: Jinja template for pages
    • templates/slides.html: Jinja template for slides

After installation, the following commands will be available:

  • mccole lint: internal project check
  • mccole render: Markdown-to-HTML translator
  • mccole stats: site statistics