Update README.md

This commit is contained in:
Stig-Ørjan Smelror 2024-02-02 13:45:43 +01:00
parent 1c2e480232
commit ba66ae25a5

View File

@ -1,13 +1,26 @@
# Quick Site Generator 2
Quick Site Generator 2 is a static website generator inspired by Nikola and written using Zsh.
```qsgen2``` is capable of creating static HTML pages using the native ```_html``` engine (that I'll describe in detail later) or by writing your pages and blogs in Markdown. It uses [Pandoc](https://github.com/jgm/pandoc/releases), mostly because it's the most compete tool for the job. Not all Linux distributions have it, so you can just download the binaries and place them where it suits you the best.
```qsgen2``` is capable of creating static HTML pages using the native ```_html``` engine that uses ```QStags``` (that I'll describe in detail later) or by writing your pages and blogs in Markdown. It uses [Pandoc](https://github.com/jgm/pandoc/releases), mostly because it's the most compete tool for the job. Not all Linux distributions have it, so you can just download the binaries and place them where it suits you the best.
You cannot mix native and Markdown when creating your project.
## Configuration
Copy ```qsgen2``` and the directory ```include``` to ${HOME}/bin/.
Then create you project directory, for example ```${HOME}/sites/new-site```.
Copy the file ```config``` and the directory ```themes``` to your project directory.
You first have to configure your site and this is done in the file [config](config).
Do the necessary changes.
Create a directory named ```blog``` if you want to have blogs on your site.
Create your index file with either ```tpl``` to use the native engine or ```md``` to use Markdown.
I will, as mentioned, create a how-to on ```QStags```.
I am considering adding a command line, ```init```, that will guide you through this process in an interactive manner.
## Themes