Git Product home page Git Product logo

jem-press's Introduction

jem-press

Jem-press is inspired by Octopress and jem-doc, hence the name. I like Octopress for all the customization and options, but it's lacking deliberately feature-poor simplicity of jem-doc. However, jem-doc doesn't use markdown, and seems kinda hacked together (no make file included, etc). So, I decided to make jem-press.

Octopress is a blog-aware site generator. Jem-press is not, and could only be blog aware if you formatted the blog yourself. In that sense, it's static. A good example of the site I'm trying to produce is the jemdoc website.

Jem-press is supposed to be simple. It's designed so that all that's required is to download this repo and change the markdown files. Everything else is taken care of -- CSS, LaTeX equations, etc.

The documentation includes all the details on

  • how to install
  • how to generate site
  • some content tips

Even though the docs are incredibly useful, I'll include a couple bullets:

  1. It's easiest to clone this repo to get started
  2. All of the content displayed on the pages are in content/
  3. Run cd path/to/jem-press; ruby update.rb to update your site

The jem-press documentation site is written in jem-press itself.

Todo

  1. Only folders within images are copied across. I should implement find content -type d | xargs cp -r html/

Features

  • simple, feature minimal (deliberately!)
  • easy to pick up
  • popular markdown formatting
  • easy for academic/static sites
  • not blog sensitive (no posts by date, no search, no keywords, etc)

jem-press's People

Contributors

clement-parisot avatar ghraecakter avatar

Watchers

James Cloos 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.