Git Product home page Git Product logo

railgun's Introduction

⚡️ 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

CopyRight

MIT 2018@misakar

check LICENSE for detail.

railgun's People

Contributors

misakar avatar oaoouo 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.