Skip to main content

A flask static site generator that uses markdown and jinja2 templates.

Project description

___________.__
\_   _____/|  |  _____     ____    ____    ____
 |    __)  |  |  \__  \   / ___\ _/ __ \  /    \
  |     \   |  |__ / __ \_/ /_/  >\  ___/ |   |  \
   \___  /   |____/(____  /\___  /  \___  >|___|  /
        \/               \//_____/       \/      \/

Build Status

Flagen is a Flask Site/Blog generator.

Installation

$ git clone https:/github.com/jeffgodwyll/flagen.git
$ cd flagen
$ pip install -e .

Usages

$ flagen --help
Usage: flagen [OPTIONS] COMMAND [ARGS]...

Flagen is a simple static site generator built on top of Frozen Flask

Options:
  --help  Show this message and exit.

Commands:
  build  Build site and generate a `build` folder
  serve  Serve site

$ flagen build --help
Usage: flagen build [OPTIONS]

Build site and generate a `build` folder

Options:
--template PATH  Pass a custom template directory
--help           Show this message and exit.

$ flagen serve --help
Usage: flagen serve [OPTIONS]

  Serve site

Options:
  --template PATH  Pass a custom template directory
  --help           Show this message and exit.

Examples

$ flagen serve

$ flagen serve --template templates/templates_material/

$ flagen serve --template templates/simple/

$ flagen build

$ flagen build --template templates/templates_material/

As a blog

Content in the pages folder are rendered as blog posts

Each post takes the following format:

title: Hello World
date: 2014-11-29
tags: [general, awesome, stuff]

**Hello World**, from a *page*! etc, etc

The blog content will be in markdown. Look in the pages folder for example

Feedback

Star this repo if you find it useful. Use the github issue tracker to give feedback on this repo or to report an issue.

Licensing

http://jeff.mit-license.org/

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flagen-0.1.tar.gz (3.1 kB view details)

Uploaded Source

File details

Details for the file flagen-0.1.tar.gz.

File metadata

  • Download URL: flagen-0.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for flagen-0.1.tar.gz
Algorithm Hash digest
SHA256 a3e1d21b8a3a7a37a07befdfde8ef9c9d6105f998d57c1ab352b5b84b7897011
MD5 d73be2b424e341dbe8d52f4cf7aed936
BLAKE2b-256 70e23bc10d7b2eccba7b041c603d8046a8764c2e4cf3916203a72cdadff67dd3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page