Giter VIP home page Giter VIP logo

website-generator's Introduction

Website Generator

This is a static site generator. It creates html files based on markdown.

Table of Contents

  1. How does it work
  2. Usage
  3. Example
  4. Install

How does it work?

It creates html file for each markdown file it finds in a given folder. You have two ways to run it - on a .md file or on a folder. If you run it on a folder it will go to all subfoldres.

For every markdown file it finds, it will look for _navbar.md at a folder above. If it finds one, it will use it as a navigation bar for this html file.

Usage

Create html files from all markdown files in a given folder:

./site some-folder

Create an html file of a specific markdown file:

./site some-markdown-file.md

Example

Let's say you have the following folder structure:

website/
├── articles
│   └── README.md
├── cookbook
│   └── README.md
├── README.md
└── talks
    └── README.md

Running ./site website will output the following:

converting the folder website
converting the markdown file: website/README.md
converting the folder website/talks
converting the markdown file: website/talks/README.md
converting the folder website/cookbook
converting the markdown file: website/cookbook/README.md
converting the folder website/articles
converting the markdown file: website/articles/README.md

Install

git clone [email protected]:oren/website-generator.git
shards install
crystal build src/site.cr

website-generator's People

Contributors

oren avatar

Stargazers

Iain Barnett avatar

Watchers

 avatar James Cloos avatar  avatar

website-generator's Issues

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.