criss

master branch1 version

master branchlatestApr 10, 2019

github.com/straight-shoota/criss

Instantaneous static site site generator and server in Crystal

22 stars

0 dependents

License: MIT

Installation

# Add this to your shard.yml
dependencies:
  criss:
    github: straight-shoota/criss
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal

0.26.1

License

MIT

Author

Johannes Müller <straightshoota@gmail.com>

Target

criss from src/app.cr

Dependencies

Runtime Dependencies

sass*github: straight-shoota/sass.cr
markd*github: icyleaf/markd
serve*github: superpaintman/serve
crinja*github: straight-shoota/crinja, branch: master

README

# criss

The *CRystal Instantaneous Static Site* is a static site generator and server modeled after Jekyll.

**ALPHA STATUS** - this is probably not yet useful for production

## Installation

Criss relies on sass.cr, and some dependencies might be required on your system. Check out the [installation instructions for `sass.cr`](https://github.com/straight-shoota/sass.cr#installation) for more details.

Download this repository and run `shards install && shards build`

## Usage

Run the executable `criss` inside a website folder. It now serves the content from this folder directly.

Run `criss help` for command line options.

## Development

TODO: Write development instructions here

## Contributing

1. Fork it (<https://github.com/straight-shoota/criss/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [straight-shoota](https://github.com/straight-shoota) Johannes Müller - creator, maintainer

criss

Installation

shard.yml

Dependencies

Runtime Dependencies

README

Documentation

Links

This branch

Dependents

Repository

Metadata