TerevintoSoftware.StaticSiteGenerator.Tool
1.2.1
See the version list below for details.
dotnet tool install --global TerevintoSoftware.StaticSiteGenerator.Tool --version 1.2.1
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local TerevintoSoftware.StaticSiteGenerator.Tool --version 1.2.1
#tool dotnet:?package=TerevintoSoftware.StaticSiteGenerator.Tool&version=1.2.1
nuke :add-package TerevintoSoftware.StaticSiteGenerator.Tool --version 1.2.1
Static Site Generator
This project aims to provide a way for c# developers to benefit from very cheap/free hosting through static files, while allowing them to use familiar ASP.NET MVC concepts (Views, Partials, Layouts, etc). This also allows you to have an initial static site that you can then update to a dynamic website backed by ASP.NET Core without starting from scratch.
Since this project converts Views into HTML files, it is not possible (at least yet) to use Models.
Packages
This project is divided in two packages:
Package | Purpose |
---|---|
TerevintoSoftware.StaticSiteGenerator | Contains the main logic of the project, depends on ASP.NET Core. |
TerevintoSoftware.StaticSiteGenerator.Tool | Contains a .NET Tool that can be invoked to perform the generation. |
Sample usage
- Install the tool:
dotnet tool install TerevintoSoftware.StaticSiteGenerator.Tool
- (optional) Create a new project:
dotnet new mvc -o MyProject
- (optional) See the available options with
ssg -h
- Run the static site generation:
ssg --project [project-path] --output [output-path]
The main website for testing out the basic set of features in this tool is here.
How to build
- Install Visual Studio 2022 (.NET 6 required), if needed. The ASP.NET Core workload is required to build the project.
- Install git, if needed.
- Clone this repository.
- Build from Visual Studio or through
dotnet build
.
Running tests
Once the solution is compiled, tests can be run either from Visual Studio's Test Explorer window, or through dotnet test
.
License
The .NET Tool and this solution are licensed under the MIT license.
Bug reports and feature requests
Please use the issue tracker and ensure your question/feedback was not previously reported.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
This package has no dependencies.
[1.2.1]: Internal re-archicture and improve code coverage to over 90%.
[1.2.0]: Adds an initial implementation for path-based views based on culture.
[1.1.1]: Fixes a URL generation bug for the default Controller actions. Previous versions were deprecated as unstable.