jing

Jing

A tiny static site generator packing a punch

Jing tai wang ye sheng cheng qi 静态网页生成器

Has built in support for Erb - and Markdown templates, Typescript compiler, Sass compiler, JavaScript/Css minifier, partial- and layout support, variable support, easily extendable, updates your page as soon as you change a file.

Installation

Add this line to your application's Gemfile:

gem 'jing'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jing

Usage

call jing on the command line or have a look at the code (it's tiny) :)

Creates a new folder mypage or updates an existing one and adds a basic setup:

$ jing create mypage
$ cd mypage

Build the current project:

$ jing build

Automatically build the page whenever a file in the project folder changes:

$ jing watch
$ jing watch -full_build true   # to not skip uglifying js files (slower)

Serves the current projects _dst folder on http://0.0.0.0:8000:

$ jing serve
$ jing serve -no_auto_reload true       # to not inject auto page reload code into html files
$ jing serve -port 1234 -root somepath  # to change port and root directory

Options that work in all commands:

-src somepath     # changes the source folder - default: ./ (current folder)
-dst somepath     # changes the output folder - default: ./_dst
-layouts folder   # changes the layouts folder - default: ./_layouts
-partials folder  # changes the partials folder - default: ./_partials

Show current version

$ jing version

File endings work like Russian dolls: They get converted from outer to inner. Rails folks should be somewhat familiar with that but here it's a bit stricter.

Folders starting with _ have special meaning, they generally won't get copied into the destination folder _dst.

_partials holds partials (TODO: explanation)

_layouts holds layouts (TODO: explanation)

`_dst' holds the generated site

.meta.yml holds global meta variables available in templates when not overwritten

I'll try and add a basic example project soon. Check out the examples folder. If you feel like giving this a try and have questions feel free to open an issue or reach out otherwise. Pull requests welcome too.

Development

Extending is fairly easy.

@converters variable in the initialize method holds a bunch of converters. Just add one in the spirit of the others.

Class methods that end in a bang ! automatically are registered as cli commands. If you wish to add a command just add a bang-method and you should be done.

Feel free to open issues for questions / ideas etc that you don't know how to work on or have no time working on as well as actual bugs and quirky etc. I'm sure there are some.

Please fork and make a pull request if you want to contribute.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pachacamac/jing.

License

The gem is available as open source under the terms of the MIT License.