Giter VIP home page Giter VIP logo

website's Introduction

webtastic

a simple website html generator written by python with extensibility in mind.

TODOs

  • Write documentation
  • Write tests (oops!)
  • Add python 3 support(?)

Dependencies

$ pip2 install jinja markdown yapsy

Usage

look at the source directory for getting the idea behind Webtastic before the arrival of the Documentation.

$ python webtastic

The above code will read the source files in the source directory and will render them by the corresponding template filename. the result will be put into a new directory named html. to compile the static pages for a directory in your webhost (for example http://example.com/myblog/) simple run the below command:

$ python webtastic --base-url=myblog

How It Works?

Webtastic is simply made of a jinja2 template directory and a source directory. when you run, it parse every .md file in your source directory with corresponding template file in template/ and writes it to html/ directory.

a source file is consists of two part. seperating by 10 dhashes. the above part is to define variables using YAML to be used by template engine and the below part is the actual content of the page using Markdown. it's really simple! just look at the source files.

----------
author: Mashhadlug
title: index page's title
layout: index
----------
# This is Heading one

and some paragraph.

Demo

currently using Webtastic

LICENSE

Webtastic is licensed under GPLv3 or any later version.

website's People

Contributors

bijanebrahimi avatar arashm avatar tuxitop avatar

Stargazers

 avatar  avatar  avatar mms avatar

Watchers

James Cloos avatar  avatar Ramin Najjarbashi avatar  avatar mms avatar  avatar Amirhossein Baghaie avatar farhad avatar

Forkers

raminnietzsche

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.