TerevintoSoftware.StaticSiteGenerator.Tool 1.3.0

.NET 6.0
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global TerevintoSoftware.StaticSiteGenerator.Tool --version 1.3.0
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local TerevintoSoftware.StaticSiteGenerator.Tool --version 1.3.0
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=TerevintoSoftware.StaticSiteGenerator.Tool&version=1.3.0
nuke :add-package TerevintoSoftware.StaticSiteGenerator.Tool --version 1.3.0

Static Site Generator

Coverage Status Nuget version

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

  1. Install the tool: dotnet tool install TerevintoSoftware.StaticSiteGenerator.Tool
  2. (optional) Create a new project: dotnet new mvc -o MyProject
  3. (optional) See the available options with ssg -h
  4. 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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
2.0.0 462 11/17/2023
1.4.1 222 7/30/2023
1.4.0 322 3/7/2023
1.3.5 258 3/5/2023
1.3.2 502 9/18/2022
1.3.1 437 8/28/2022
1.3.0 454 8/20/2022
1.2.2 501 6/27/2022
1.2.1 440 6/11/2022
1.2.0 493 6/5/2022
1.1.1 429 5/30/2022

[1.3.0]: Add a new option to skip deleting existing output. Makes the view generation run inside the project's folder.
[1.2.2]: Fixes an issue where a single culture always generated structures/links as if there were multiple cultures.
[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.