Skip to content

TheQuantron/kilosite

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kilosite

A static site generator made in C#, useful for creating small blog sites.

Installation

Download or build the kilosite.exe application, place it anywhere and cd into that directory to run.

Usage

 ./kilosite.exe <create | newpost | build> <project_name>

Commands

  • create <project_name> Initialises a new blog site .
  • newpost <project_name> Creates a new blog post with template data.
  • build <project_name> Builds the blog into static HTML.

When a new blog is created, kilosite creates an /articles folder where all article .md files will go.

All article files are populated with base title, url and date variables. Only the url variable is required, as kilosite will handle the rest. If needed, the user can create as many article variables as they'd like, accessed through {{ variable_name }}.

Variables must be defined between the opening and closing --- found at the top of each .md file which must adhere to the following syntax:

---
key: value
---

Kilosite replaces {{ content }} found in any ****_template.html file with it's respective .md file once.

If {{ table of contents }} is found in the index_template.html file it will be replaced with a list of all current articles when built.

A /templates folder is also produced which contains template files to structure your blog site. Any additional files in this directory will be automatically copied to the build folder during the build process.

When build <project_name> is run a new folder named build will be found in your blog's directory containing everything needed to host your site.

About

A static site generator made in C#, useful for creating small blog sites.

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • C# 75.0%
  • CSS 17.2%
  • HTML 7.8%