hestia

Hi! Me Hestia! :heart:

Me am a markdown-based static site generator.

All you have to do is to write markdowns, then me publish your static site!

Demo

Yes, this official site is made by hestia!

Install

$ npm install -g hestia

Feature

• Convert markdown/*.md to public/*/index.html
• Customizable theme
• Searchable in your browser
• Support emoji :+1:

Usage as a markdown converter

First, set up your hestia.config.js like this:

module.exports = {
  markdownPath: 'markdown',
  publicPath: 'public',
  app: {
    charset: 'utf8',
    port: 3000,
    url: 'http://localhost',
    title: 'Your App Title',
    description: 'Your app description.',
    author: {
      name: 'Phamilia Hestia',
      url: 'http://hestia.phamilia.co',
      startYear: 2017
    },
    markdownLinkViewable: false
  },
  design: {
    theme: 'bulma',
    markdownStyle: 'github',
    codeHighlightStyle: 'github'
  },
  menu: {
    order: 'asc',
    orderBy: 'filename',
    selected: 'first'
  },
  icon: {
    github: 'https://github.com/phamilia/hestia',
    twitter: null,
    facebook: null
  }
};

Then, run hestia commands like below:

# 1. Build markdowns to html
$ hestia build --config hestia.config.js

# 2. Start application
$ hestia start --config hestia.config.js

Usage as a Hestia application

# 1. Create Hestia Application
$ hestia new <app-name>

# 2. Write markdown documents at markdown/*.md

# 3. Start application
$ cd <app-name>
$ hestia start

# 4. See http://localhost:3000