Giter VIP home page Giter VIP logo

momus's Introduction

Momus - A static site generator from Markdown files

About

Momus is a simple and easy to use static site generator with emphasis on blogs.

Philosophy

The philosopy of Momus is simple: You write your content in Markdown, prepare a template and run node index.js. Your blog will be generated in a matter of seconds.

Features

  • Handlebars.js templating
  • Support for metadata for every markdown(post) you write.
  • Include / exclude markdown files for final build
  • Ready to use generated html files. Upload them to Github pages or host them on your own.

Demo

Check out my blog which is made with Momus: https://thiodordelis.github.io/blog/blog.html

Requirements

You need Node.JS and npm

Getting started

Clone this repo:

git clone https://github.com/thiodordelis/momus.git

Install dependencies with npm:

npm install showdown js-beautify glob handlebars parse-markdown-metadata chalk yargs

Write your HTML template (sample), your posts in Markdown(sample) and create your blog with:

node index.js 

Your blog resides inside the __public folder

Help

Run

node index.js -h

Future

Right now, Momus will generate your blog in a single page with posts in their full length. I'm planning to add support for rendering posts with just the title and a preview text. Also, tags are coming in the next releases.

Support

You can support my project by hitting the โญ button!

momus's People

Contributors

thiodordelis avatar

Watchers

theodoros klikas avatar  avatar  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.