Still: a composable Elixir static site generator

🚧 This package is still in progress - badumm tss

Still is a different take on building static sites.

Still takes a step back from the status quo, to a simpler time, without compromising on the great developer experience some of us have grown used to.

Still is the web, still how you used to. Still weird. Still simple.

Still focuses on your happiness and speed of development. It automates the boring parts and leaves the good ones to you.

Still shines the spotlight on your abilities to write the best code you can. It is customisable, composable and as extensible as you want to. It is as powerful as you are.

Still is our gift to the community. Stay simple. Stay weird.

For more information please read the documentation.

Installation

To install Still you add it to your dependency list. You should be able to add it to any mix project.

For new projects

Run mix archive.install hex still_new to install the archive on your system.

Afterwards, create a static site by running mix still.new my_site. That's it!

Adding to an existing project

Add still as a dependency in mix.exs:

def deps do
  [
    {:still, "~> 0.8.0"}
  ]
end

Open up config.exs and set the input and output folders:

config :still,
  input: Path.join(Path.dirname(__DIR__), "priv/site"),
  output: Path.join(Path.dirname(__DIR__), "_site")

Create a file index.slime in the input folder.

For more information please visit the website.

Contributing

If you're considering contributing to Still, thank you. We keep an updated list of bugs and features on the issue tracker. If you can't find the bug or feature you have in mind, please open an issue first, before creating a pull request.

Requirements & Setup

1. Download the repo

$ git clone https://github.com/still-ex/still.git

2. Move to project directory & Install dependencies

$ cd still && ./bin/setup

3. Optionally, install an image processor

Some of the tests related to images require an image processor to be installed. By default, Still relies on ImageMagick, but if you install still-imageflow as a dependency it will use imageflow instead.

From this point onwards, you should be ready to go.

Expected Pull Request contents

Please make sure the PR title and description clearly explain the proposed changes. Linking to a relevant issue by adding Closes *ISSUE_NUMBER* on the PR description is very welcomed.

All proposed changes should be accompanied by unit tests that provide coverage for those changes.

Running tests

To run tests, simply run the following on the project directory.

$ mix test

About

Still was created and is maintained with ❤️ by Subvisual.

License

Still is released under the ISC License.