Git Product home page Git Product logo

node-ssg's Introduction

Simple Custom Static site generator

Table of Contents
  1. About The Project
  2. Getting Started

About The Project

This project is a simple custom static site generator, implemented in node JS.

The code takes in markdown files from the 'src/content' folder, parses the data in each file, and generates a html file in an output folder 'dist'.

You can manually add an 'index.css' file in the css file to style the generated html files.

Built With

The technologies used are:

  1. node JS

(back to top)

Getting Started

These are the steps required to use this project:

Prerequisites

NodeJS

nvm install latest

Installation

  1. Clone the repo
   [email protected]:Kangonga/node-ssg.git
  1. Install the dependencies npm install

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link:link

(back to top)

Credits

Katik Nair. Their article on medium waws helpful in getting to know how to go about this project

(back to top)

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.