Giter Site home page Giter Site logo

sssg's Introduction

SSSG (Stupid Static Site Generator)

Build static site from markdown files and html templates

Features

  • Relative to absolute links
  • Code highlighting
  • Math formulas

How to use

  • clone this repo
  • change things
  • build with make
  • test with make testing && make serve

Documentation

project tree

  • source/ contains *.md to convert
  • resource/ contains static resources like images, videos, css ..
  • theme/ contains pandoc html templates
  • theme/resources/ same as resources/ but for theme
  • settings.yaml configuration file for building the site
  • build/, build/testing/, build/release/ contains the static site

steps of conversions

given a file.md produces a file/index.html with pandoc template base.html combined with settings.yaml

links mapping

  • all resources are combined in the build/[release or testing]/resources/ folder
  • if you want to make a link in page1.md to subfolder/page2.md write [link](subfolder/page2)

sssg's People

Contributors

zwirgioilredelcodice avatar

Stargazers

 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.