SiteKit is a command-line tool designed to simplify the creation, building, and serving of static websites. It provides a streamlined workflow for developers to quickly scaffold new projects, build static assets, and serve them locally for testing.

• Project Scaffolding: Quickly create a new site project using predefined templates.
• Static Site Building: Build static assets from source files, including HTML and Markdown.
• Local Development Server: Serve your site locally for testing and development.
• Customizable Templates: Use or create templates to standardize your site structure.
• Hot Reload: Quickly make changes to your project and see them happen in realtime without rebuilding.

• .NET 8.0 or later
• Basic knowledge of command-line tools

1. Clone the repository or download the source code.
2. Build the project using the .NET CLI:
3. Install the tool globally:

git clone https://github.com/CodingBoson/SiteKit.git
cd ./SiteKit/SiteKit

./install.ps1 # For Windows
./install.sh # For Linux/MacOS

Create a new site project.

• siteName: The name of the new site project.
• -t, --template: (Optional) The template to use. Defaults to default.

Build the static site from source files.

Serve the site locally for testing.

• -u, --url: (Optional) The URL to serve the site. Defaults to http://localhost:9443/.
• -u, --url: (Optional) The URL to serve the site. Defaults to http://localhost:9443/.
• --no-build: (Optional) Skip the build step before serving.

A typical SiteKit project has the following structure:

myBlog/
├─ Layout/         # Contains layout html files.
├─ Pages/          # Your Markdown or HTML pages
├─ wwwroot/        # CSS, images, JS, etc.
├─ sitekit.json    # Site configuration (title, properties, etc.)
└─ publish/        # Auto-generated static output

The sitekit.json file contains the configuration for your site. Example:

{
  "Name": "SiteKit",
  "Properties": {}
}

To build the project, run:

sitekit build

To run the tests, use:

sitekit serve

https://sitekit.secure-pages.uk Is built using SiteKit.

SiteKit renders projects under 1 second.

See the Templates README file for more information.

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes and push them to your fork.
4. Submit a pull request.

This project is licensed under the GPL-3.0 License. See the LICENSE file for details.

• Cocona for command-line parsing.
• Markdig for Markdown processing.

A new successor to SiteKit, named 'WebKit,' is currently in development. This tool aims to provide a faster and more user-friendly solution for static web development. It will be available on GitHub and the BosonWare Technologies organization.

What does this mean for SiteKit?

The transition to WebKit marks the end of support for SiteKit, as it was an experimental project. WebKit has emerged as a more powerful tool, backed by the BosonWare Foundation, ensuring long-term maintenance and support.