robert/cssitegen
robert/cssitegen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity
A static site generator written in C#
34 Commits 2 Branches 3 Tags 336 KiB
C# 98.8%
HTML 1.2%
d868eac72f
Go to file
Robert Morrison d868eac72f
UNCONVENTIONAL COMMIT Bump to 0.0.2 
While I would usually try and stick to the conventional commits
standard this commit is a big one.

This commit Bumps us to 0.0.2 And completely changes how you interact
with the program.
Now it is easier as you only need to specify the project directory on
the commandline (OR be in the directory of the site you want to build)

Also introduced is the cssitegen.json file that all projects must use.
This means that static information such as the basename, source, and
destination are kept with the files.

ProjectSettings is used to hopefully make managing a site easier,
although future refactoring may join the RuntimeSettings and
ProjectSettings into one class.

There are some obvious issues with the project in its current state but
pending testing with a live domain, it does appear to actually work as
intended. (if this is true then the code just needs refactoring and
tidying to qualify for a 0.1.0 Release.)

Future features planned include
- Code to generate pages from data
- Template nesting (or a custom template templating language)
- Introduction of image conversion to webp (with fallback to RawCpy)
- consistency enforcement, to ensure that deleted source files mean
  deleted destination files.
2024-05-31 02:03:46 +01:00
ProjectSettings UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00
RuntimeSettings UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00
SiteFile UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00
Testing UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00
Utils UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00
.gitignore Update gitignore 2022-06-21 22:48:20 +01:00
.vimspector.json Initial Commit 2022-06-14 15:27:48 +02:00
csSiteGen.csproj UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00
LICENSE chore(repo): Add LICENSE and Readme 2024-03-29 14:07:19 +00:00
Logo.png Add Logo 2022-07-07 02:00:02 +01:00
Logo.svg Add Logo 2022-07-07 02:00:02 +01:00
Program.cs UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00
Readme.md chore(repo): Add LICENSE and Readme 2024-03-29 14:07:19 +00:00
TODO UNCONVENTIONAL COMMIT Bump to 0.0.2 2024-05-31 02:03:46 +01:00

Readme.md

CsSiteGen

A relatively simple (for now) static site "generator". The heavy lifting of this project is actually performed by Pandoc so you better make sure you install it on your system.

How to use

This project is nowhere near a finished thing so I wouldn't recommend relying it on it at the moment.

But the general method of operation (for the moment) is to run it like this:

cssitegen convert [INPUT_DIRECTORY] [OUTPUT_DIRECTORY]

At the moment the basic Markdown to HTML conversion is implemented, but future plans include automatic conversion of images to webp and other optimisations.

Future plans

Automatic page generation using pre-process steps and temporary files. E.G Contents pages, index pages etc...