Skip to content

misakar/railgun

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚡️ railgun

static site generator

Step1: Initialize a blog

$ railgun init blog

Step2: Config

$ cd blog
$ vim config.py

don't forget to change default config class

config = {
    'default': MyConfig
}

Step3: Writing

$ cd blog
$ railgun new newblog

then

$ vim app/pages/newblog.md

the default article template show below:

title:
date: %Y-%m-%d %H:%M:%S
tags: ['tag1', 'tag2']

the default format for the blog is markdown, you can change it in the config.py file

class Config(object):
    # ......
    FLATPAGES_EXTENSION = '.md'

Step4: Preview

$ railgun server

Step5: Build and Deploy

$ railgun build
$ railgun upload

done!
enjoy writing :)

Install

Install from git

$ git clone https://github.com/misakar/railgun/ railgun
$ cd railgun
$ pip install --editable .

Test

$ git clone https://github.com/misakar/railgun/ railgun
$ cd railgun
$ pip install --editable .
$ py.test -s

More details of railgun

Change Logs

20180104

add code highlight

20171231

back

20170910

add blog :)

20170907

add tests!

20170901

speed up! generate 200 files in just 5s :)

20170831

fix bug :(

20170830

continuse

ToDo

  • speed up
  • tests
  • code highlight
  • logging system
  • theme system
  • reverse generation
  • article pending state

CopyRight

MIT 2018@misakar

check LICENSE for detail.

About

py static site generator, simple and fast

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published