GithubHelp home page GithubHelp logo

thoemmi / pretzel Goto Github PK

View Code? Open in Web Editor NEW

This project forked from code52/pretzel

0.0 2.0 0.0 4.84 MB

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

License: Microsoft Public License

PowerShell 0.85% Batchfile 0.03% C# 97.97% Liquid 0.86% CSS 0.29%

pretzel's Introduction

AppVeyor build status Coverity Scan Build Status Coverage Status Chocolatey Nuget

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 and should be compatible with basic Jekyll websites. If you are not familiar with Jekyll, have a read at http://jekyllrb.com/docs/usage/

Usage

The principal commands are the following but more informations are available on the 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 infos on the wiki

Contributing

All contributions are welcome, please read our contributing guide.

Attribution

โ€œPretzelโ€ symbol by Edward Boatman on The Noun Project, from The Noun Project collection.

pretzel's People

Contributors

shiftbot avatar thoemmi avatar andreyakinshin avatar markheath avatar ronnykarlsson avatar kodfodrasz avatar shiftkey avatar thiagojedi avatar dkarzon avatar vikingcode avatar lukencode avatar markvantilburg avatar shiftkey-tester avatar andreimarukovich avatar andrewtobin avatar jakeginnivan avatar alexkopy avatar switchspan avatar tiernano avatar tathamoddie avatar hartez avatar dtchepak avatar dubeaud avatar keesschollaart81 avatar khellang avatar andrexx avatar mvalipour avatar sunilrav avatar jongalloway avatar timmurphy avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.