Giter VIP home page Giter VIP logo

jekytrum's Introduction

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.

jekytrum's People

Contributors

georgeosddev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.