https://github.com/code52/pretzel

A site generation tool (and then some) for .NET platforms
https://github.com/code52/pretzel

jekyll pretzel static-site-generator

Last synced: 4 days ago
JSON representation

A site generation tool (and then some) for .NET platforms

• Host: GitHub
• URL: https://github.com/code52/pretzel
• Owner: Code52
• License: ms-pl
• Archived: true
• Created: 2012-01-30T11:52:50.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2020-06-25T15:57:21.000Z (over 4 years ago)
• Last Synced: 2024-09-28T02:41:03.227Z (4 days ago)
• Topics: jekyll, pretzel, static-site-generator
• Language: C#
• Homepage: http://code52.org/pretzel/
• Size: 6.61 MB
• Stars: 598
• Watchers: 40
• Forks: 163
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
/!\ It has been a while since we lost the time and will to work on this project, so it has been archived.

Feel free to fork it and proposed an adapted version, or to use [Wyam](https://wyam.io/), [Statiq.Web](https://statiq.dev/), [Jekyll in Windows](https://jekyllrb.com/docs/installation/windows/) or [any other static site generator](https://www.staticgen.com/).

---

[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/rp8nq03r4b7mdecf?svg=true)](https://ci.appveyor.com/project/laedit/pretzel)

[![Coverity Scan Build Status](https://scan.coverity.com/projects/3949/badge.svg)](https://scan.coverity.com/projects/3949)

[![Coverage Status](https://coveralls.io/repos/Code52/pretzel/badge.svg)](https://coveralls.io/r/Code52/pretzel)

[![Ptrezel tag on Stack Overflow](https://img.shields.io/badge/stackoverflow-pretzel-orange.svg)](http://stackoverflow.com/questions/tagged/pretzel)

[![Chocolatey](https://img.shields.io/chocolatey/v/pretzel.svg?style=flat)](https://chocolatey.org/packages/pretzel/)

[![Nuget](https://img.shields.io/nuget/v/Pretzel.Logic.svg)](https://www.nuget.org/packages/Pretzel.Logic/)

## Pretzel

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

Pretzel follows the same conventions as [Jekyll](https://github.com/jekyll/jekyll) and should be compatible with basic Jekyll websites. If you are not familiar with Jekyll, have a read at [http://jekyllrb.com/docs/usage/](http://jekyllrb.com/docs/usage/).

### Usage

The principal commands are the following but more informations are available on the [wiki](https://github.com/Code52/pretzel/wiki)

**Create** is used to create the folder structure for a new site:

    pretzel create

    

If the site should be at a specific folder, this can be specified as a parameter:

    pretzel create C:\path\to\folder

**Bake** is used to generate a site based on the contents of a folder.

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 liquid

    

**Taste** is for testing a site locally - make a change, and pretzel should handle regenerating the page when a file changes.

To test a site locally, run:

    pretzel taste 

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

    pretzel taste --port 5000

To stop the site, press q.

*More information on the [wiki](https://github.com/Code52/pretzel/wiki)*.

### Plugins

Plugins are supported in pretzel, more info on the dedicated [wiki page](https://github.com/Code52/pretzel/wiki/Plugins).

### Contributing

All contributions are welcome, please read our [contributing guide](CONTRIBUTING.md).

### Attribution

 “[Pretzel](https://thenounproject.com/noun/pretzel/#icon-No555)” symbol by Edward Boatman on [The Noun Project](https://thenounproject.com/), from The Noun Project collection.