Skip to content

Latest commit

 

History

History
44 lines (23 loc) · 1.69 KB

README.md

File metadata and controls

44 lines (23 loc) · 1.69 KB

Pretzel

A simple, pluggable site generation tool for .NET developers and Windows users (with Mono support planned I think)

Usage

Initially, we plan to support two modes - bake and taste. Bake is for a once-off generation of the site, whereas taste is for testing a site locally - make a change, and pretzel should handle regenerating the page when a file changes.

To scan the current directory for a website and detect the content to process, run:

pretzel bake 

To scan a specific folder and parse the contents, run:

pretzel bake C:\path\to\folder

To explicitly specify the input - we should support inferring the input based on the files found anyway - run:

pretzel bake --engine jekyll

To test a site locally (we plan to use Dragonfly), run:

pretzel taste 

To specify the port to serve the site from (default will be 4000), run:

pretzel taste --port 5000

Getting started

Getting started with Git and GitHub

Once you're familiar with Git and GitHub, clone the repository and run the .\build.cmd script to compile the code and run all the unit tests. You can use this script to test your changes quickly.

Discussing ideas

  • Trello Board - add ideas, or claim an idea and start working on it!
  • JabbR Chatroom - discuss things in real-time with people all over the world!