EngineBay.DocumentationPortal 2.0.6

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package EngineBay.DocumentationPortal --version 2.0.6
                    


                    

                
NuGet\Install-Package EngineBay.DocumentationPortal -Version 2.0.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="EngineBay.DocumentationPortal" Version="2.0.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="EngineBay.DocumentationPortal" Version="2.0.6" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="EngineBay.DocumentationPortal" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add EngineBay.DocumentationPortal --version 2.0.6
                    


                    

                
#r "nuget: EngineBay.DocumentationPortal, 2.0.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package EngineBay.DocumentationPortal@2.0.6
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=EngineBay.DocumentationPortal&version=2.0.6
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=EngineBay.DocumentationPortal&version=2.0.6
                    


                            Install as a Cake Tool

EngineBay.DocumentationPortal

NuGet version Maintainability Test Coverage

DocumentationPortal module for EngineBay published to EngineBay.DocumentationPortal on NuGet.

About

This is the documentation repository for Engine Bay, it uses mkdocs to generate a static site from markdown files. Documentation can be added as markdown files in the docs folder.

Prerequisites

Please ensure that you have the following installed

  • Node 
    node --version
  • Python 
    python --version
python3 --version
  • Pip. Pip should be installed with Python, check using the following command 
    pip3 --version

Usage

The mkdocs build command will be executed when we build this project using dotnet build.

In the development environment mkdocs will build with the --dirty flag, this will give the fastest build times but could have issues with links etc. To fix these issues either build using mkdocs build --strict or by using the build script.

In the pipelines we wil do the longer full build.

Deploying the static site

TBC - This will be hosted as github pages.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.6 257 1/30/2024
2.0.5 280 1/10/2024
2.0.4 251 12/20/2023
2.0.3 189 12/14/2023
2.0.2 216 12/7/2023
2.0.1 226 11/29/2023
2.0.0 198 11/23/2023
1.0.7 249 11/8/2023
1.0.6 179 11/2/2023
1.0.5 190 11/2/2023
1.0.4 203 11/1/2023
1.0.3 273 10/31/2023
1.0.2 196 10/31/2023
1.0.1 192 10/10/2023
1.0.0 296 9/28/2023
0.2.0 200 9/27/2023
0.1.1 194 9/26/2023
0.1.0 202 9/26/2023