2 releases (1 stable)

1.0.0 Dec 10, 2020
0.1.0 Dec 7, 2020

#40 in #html-css

26 downloads per month

MIT license

235KB
435 lines

rust-coal πŸš‚

A static HTML development tool, built with Rust

Image of Coal Mine Cart

Who is this for?

Those that want to generate a basic static HTML site, with perhaps 1-10 pages, and do not want to maintain layouts, navigation elements, and footers across multiple files.

If you need programmatic components, then it would be better to utilize a more hands-on system like GatsbyJS, React Static, or a Content Management System (CMS) such as WordPress.

Just like in a typical Jamstack solution, the static HTML output can be easily served on GitHub Pages, Firebase Hosting, and a number of other places. Also see about upcoming Docker support below.

Documentation

See the Coal Docs for installation steps and detailed instructions.

Features

  • Blazing Fast πŸš€ (Seriously - its fast)
  • Zero config πŸ“„
  • Convention Over Configuration πŸ’œ
  • Batteries Included πŸ”‹
  • Standard HTML 🌠
  • HTML,CSS,JS minification πŸ—œοΈ
  • Asset Bundling πŸ“¦
  • Supports static folder πŸŽ“
  • Supports images/fonts πŸ“¦
  • Local Dev Server βš’οΈ
  • Basic Nested CSS ~SCSS πŸ’… Using Grass
  • Smart Execution During Local Dev ✨ (No need to restart server for any changes)
  • Leverages Locomotive Emoji πŸš‚

crate

https://crates.io/crates/coal

Platforms / Technologies

Current Version

v1.0.0

Showcase

Sites using coal to generate simple static HTML websites - Add yours via PR:

Future Features

For feature requests, please see this issue.

Some ideas (check issue for latest list):

  • Docker build script πŸ‹
  • Custom reusable components (Like React or Vue) βš›οΈ
  • Uglification of JS 🧟
  • Option to produce external files for CSS and JS 🎁

Why Coal?

The name coal is just a shortened version of the word coalesce.

coΒ·aΒ·lesce /ˌkΕΙ™Λˆles/ verb come together to form one mass or whole.

Dependencies

~33MB
~697K SLoC