Skip to content
A simple static website generator written in Elixir
Elixir HTML
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config Add a test for `open` command Jan 11, 2020
lib feat(serum): print information about loaded theme May 4, 2020
priv/build_resources
serum_new
serum_sdk feat(sdk): define Serum.V2.Theme behaviour Apr 25, 2020
test feat(serum): print information about loaded theme May 4, 2020
test_fixtures
.credo.exs
.formatter.exs Add Serum.Plugin.Client.Macros module Nov 29, 2019
.gitignore Update .gitignore files Nov 28, 2019
.travis.yml Update .travis.yml Nov 28, 2019
CHANGELOG.md Serum v1.3.0 Nov 28, 2019
LICENSE
README.md
mix.exs fix(serum): dialyzer errors Apr 8, 2020
mix.lock build(serum): update dependencies Apr 8, 2020

README.md

Serum

Build Status Coverage Status

Serum is a simple static website generator written in Elixir.

Like some of other static website generators, Serum focuses on blogging. And if you know how to write markdown documents and how to handle EEx templates, you can easily build your own website.

🚧 CURRENT STATUS OF THIS REPOSITORY 🚧

Codes in the master branch are currently undergoing HUGE changes toward "Serum 2.0," so don't expect anything would work properly. Also, I'm not going to accept any issue or pull request regarding "Serum 2.0" until things are kinda ready.

In the meantime, since codes for the existing Serum 1.x versions are still maintained in the v1/master branch, you are welcome to open any issue or pull request related to Serum 1.x. Just make sure you set the target base branch to v1/master, not master, when opening pull requests.

I apologize for your inconvenience!

Getting Started

Use Mix to install the Serum installer archive from Hex.

$ mix archive.install hex serum_new

You can now use serum.new Mix task to create a new Serum project.

$ mix serum.new /path/to/new_website

cd into the new project directory and install Serum.

$ cd /path/to/new_website
$ mix do deps.get, deps.compile

Try building the website, or spin up the development server.

# Your website will be built at /path/to/new_website/site
$ mix serum.build

# Your website will be built and served at http://localhost:8080
$ mix serum.server

Please visit the official website for more guides and documentations.

LICENSE

Copyright (c) 2019 Eunbin Jeong (Dalgona.) project-serum@dalgona.dev

MIT License. Read LICENSE for the full text.

You can’t perform that action at this time.