Simple static site generator
Scala CSS Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
project
public
sbt
script
src/main
.gitignore
README.md
build.sbt

README.md

Jekytrum

Jekyll + Xitrum = Jekytrum

Jekytrum is a simple static site generator inspired by Jekyll and developed on top of Xitrum.

Philosophy

  • Reactive

    Jekytrum works reactive with source content. When markdown files are created/modified/deleted, Jekytrum converts markdown to html automatically. And created html will given an url without server restart. (Live reloading feature will be available soon)

  • Hackable

    You can use or create any custom converter as you like. There are 4 default converter based on Scalamd, Pegdown, GithubAPI, and NonConverter. And you can use any custom theme as you like.

  • Portable

    Jekytrum only needs JVM as middleware. It does not need any Database. All dependency are embedded with build.sbt.

Usage

  • Save (.markdown |.md) files into src/main/markdown.

  • Start server with sbt/sbt run as Xitrum way.

  • Routing will automatically assigned depend on markdown file path and name.

  • If client requested url to directory, jekytrum try fallback to show index.md.

    Ex.

    • src/main/markdown/sample.md will be rendered on http://localhost:8000/sample
    • src/main/markdown/parent/child.md will be rendered on http://localhost:8000/parent/child
    • http://localhost:8000/parent/ will be respond with src/main/markdown/parent/index.md

Feature

  • Dynamic conversion
  • Rebootless routing
  • Asynchronous built-in Http(s) server based on Xitrum on Netty
  • Keyword-Search with power of Elasticsearch

Todos

  • Default theme
  • Use hazelcast as datastore
  • Make scalable(Share converted content between instances via hazelcast)
  • Make runnable with xitrum-package
  • Add live reload feature
  • Add command line tool like docpad
  • Follow the good parts from existing systems
  • And fix known Issues

Licence

Source code can be found on github, licenced under MIT.

Developed by Takeharu.Oshida.