https://github.com/still-ex/still
A composable Elixir static site generator
https://github.com/still-ex/still
elixir static-site-generator
Last synced: 3 months ago
JSON representation
A composable Elixir static site generator
- Host: GitHub
- URL: https://github.com/still-ex/still
- Owner: still-ex
- License: isc
- Archived: true
- Created: 2020-07-30T10:24:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-18T13:10:09.000Z (over 2 years ago)
- Last Synced: 2025-10-18T16:58:16.696Z (3 months ago)
- Topics: elixir, static-site-generator
- Language: Elixir
- Homepage: https://stillstatic.io
- Size: 149 MB
- Stars: 255
- Watchers: 11
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Still: a composable Elixir static site generator
[![][build-badge]][build]
[![][hex-badge]][hex]
[![][docs-badge]][docs]
🚧 **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][docs].
## 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`:
```elixir
def deps do
[
{:still, "~> 0.8.0"}
]
end
```
Open up `config.exs` and set the input and output folders:
```elixir
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][website].
## Contributing
If you're considering contributing to Still, thank you. We keep an updated list
of bugs and features on the [issue tracker][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
```sh
$ git clone https://github.com/still-ex/still.git
```
2. Move to project directory & Install dependencies
```sh
$ 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][imageMagick], but if you install [still-imageflow][still-imageflow] as a
dependency it will use [imageflow][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.
```sh
$ mix test
```
## About
Still was created and is maintained with :heart: by [Subvisual][subvisual].
![Subvisual][sub-logo]
## License
Still is released under the [ISC License](./LICENSE).
[website]: https://stillstatic.io
[subvisual]: https://subvisual.com
[docs]: https://hexdocs.pm/still/getting_started.html
[hex]: https://hex.pm/packages/still
[build]: https://github.com/still-ex/still/actions
[sub-logo]: https://raw.githubusercontent.com/subvisual/guides/master/github/templates/logos/blue.png
[hex-badge]: https://img.shields.io/hexpm/v/still?style=flat-square
[build-badge]: https://img.shields.io/github/workflow/status/still-ex/still/Elixir%20CI?style=flat-square
[docs-badge]: https://img.shields.io/badge/-docs-informational?style=flat-square
[issue-tracker]: https://github.com/still-ex/still/issues
[imageMagick]: https://imagemagick.org/index.php
[still-imageflow]: https://github.com/still-ex/still_imageflow
[imageflow]: https://github.com/imazen/imageflow