Scatic is a minimal static site generator written in Scala using Ammonite as my personal blog/notes site. I know, there is a plenty of static site generators out there so why Scatic? Well, it is a pure personal playground! I love the DIY approach sometimes.
It should work well on any operating system with JRE8 installed, even though is has been tested only on OSX and Linux Ubuntu. Ammonite-REPL does not support Windows, even though Ammonite-Ops (used by Scatic) does. It means that you should be able to use Scatic on your Windows machine.
It is freely inspired by:
- Parsing content from Markdown files using Atlassian CommonMark
- YAML front matter for post's metadata (category, tags, date, ...) using Atlassian CommonMark Extension YAML front matter
- Posts by category
- Posts by tag
- Rendering HTML using Scalatags
- Project skeleton generation
- Embedded Jetty server for easy development
The Main.sc
script works in three operational modes (generate, serve and clean). Pass the right arg to the script in order to execute it.
- install Ammonite
- Open a new terminal windows
- Clone or download the repos
$ git clone https://github.com/indaco/scatic
- Start generating with sample content
$ amm main.sc -- --mode generate
- Serve the result
$ amm main.sc -- --mode serve
- Open a browser windows to
localhost:8080
Add your blog posts to resources/posts
as Markdown files and:
- Generate the site:
$ amm main.sc -- --mode generate
- Serve the result:
$ amm main.sc -- --mode serve
- Open a browser windows:
localhost:8080
Licensed under the MIT License, see the LICENSE file.