GithubHelp home page GithubHelp logo

hecto's Introduction

hecto

Super simple Markdown blog server.

Hecto default theme

Features

  • Transform a folder of Markdown files to a blog in a single command
  • (Somewhat buggy) Live reloading on new posts and theme changes
  • Renders LaTeX equations (using KaTeX)

Usage

From the directory you want to serve: hecto

To specify the directory to serve: hecto /path/to/folder/

By default, those will serve at http://127.0.0.1:7878

Arguments

  • --hostname HOSTNAME: Specify a custom hostname (or -h)
  • --port PORT: Specify a custom port (or -p)
  • --theme /path/to/theme/: Specify a custom theme (or -t)

Themes

Hecto comes with a default theme, but you can easily make one yourself!

Themes are made of three Handlebars templates:

  • post.hbs: The template that blog posts are rendered to
  • folder.hbs: The template that blog folders are rendered to
  • page.hbs: The template that contains elements common to both posts and folders, like the header

Check out the default theme for more information!

hecto's People

Contributors

flix477 avatar

Stargazers

Nick Darnell avatar

Watchers

 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.