blog-engine-sac

Blog

This is a static site generator, that uses markdown files as input and outputs web pages.

How to use ?

Set up

1. Download NodeJS.
2. Create a new project (folder)
3. Create a valid package.json file with npm init for example
4. Run the command npm i blog-engine-sac --ignore-scripts
5. add script "sac": "node node_modules/blog-engine-sac/source/main.js" inside package.json
6. follow instructions below to create required files
7. npm run sac
8. to view the results use a static file server

Create a new post

Create a new markdown file in the folder source/. A markdown file is a normal text file with .md file extension. The name of the file is used as the name of the post. Then rebuild.

about page

Create file source/extras/about.md.

contact page

Create file source/extras/contact.md.

footer

Create file source/extras/footer.md.

categories

Create file source/extras/categories.json With the following content

[{
    "tag": "categorieA",
    "name": "categorieA"
},{
    "tag": "categorieB",
    "name": "categorieB"
},]

categories are provided by the user as an array for the entire blog

for example: travel, cuisine, sports

Each category will have a dedicated index page that acts like the main index page but only lists post of that category. Posts will be in that category if they have a corresponding tag.

Edit Images

Open folder images Replace the images with new ones but keep the exact filename to not break the links. (Images are linked from other files, not copied, the name of the files are used)

Required images

• images/about-bg.jpg
• images/contact-bg.jpg
• images/home-bg.jpg
• images/post-bg.jpg

user provided tags

auto generated tags

are gathered from the plain text of each post based on heuristacs (rarity and uniqueness)

tags

tags is a set that combines categories, user provided tags and auto generated tags. It is used for search function. They are also displayed after the post.

What is mark down

A text format. Learn it here https://commonmark.org/help/

About the code

Don't remove, edit or add any other file unless you know exactly what you are doing!

Design starting point

Start Bootstrap - Clean Blog is a stylish, responsive blog theme for Bootstrap created by Start Bootstrap. This theme features a blog homepage, about page, contact page, and an example post page along with a working PHP contact form.

HTML files

are generated. Do not edit directly

CSS

The CSS minified file was hand edited. Do not rebuild.

About

Copyright and License

CC0