onepage 0.1.7

A simple static site generator
Documentation

ONEPAGE

Overview

A simple static site genertor, convert md posts to html.

Online demo

My blog

Usage

from repo

  • clone this repo, and:
  • cargo run -- build to build pages
  • cargo run -- serve to build pages, and make a server at localhost

from cargo

  • cargo install onepage
  • onepage init [dir] : download template files from github
  • onepage serve
  • onepage build
  • onepage new {filename}: create new post

Structure

  • /pages: markdown source file
    • index.md => index page
    • /posts/*.md => post page
    • /image images used in markdown file
  • /dist: generated site
  • /static: static resources
    • /assets: img/css/font
    • /favicon favicon files
  • /templates: html templates
  • /src: rust src

New post

  • make a .md file in /pages/posts/
  • you can copy from demo md files
  • at present, post page must have a fontmatter header, including title(required),date(required),tags(optional)
  • or you can use onepage new {filename} to create new post.
---
title: hello world
date: 2020-03-15 10:54:39
---

---
title: hello world
date: 2020-03-15 10:54:39
tags:
  - awesome-tag
  - more-awesome-tag
---

Todo

  • custom site config file (maybe not)
  • generate new page
  • live reload
  • site initialize to new path
  • css style
  • add command line
  • serve /dist
  • watch /pages and rebuild

reference