EngineBay.DocumentationPortal
2.0.2
See the version list below for details.
dotnet add package EngineBay.DocumentationPortal --version 2.0.2
NuGet\Install-Package EngineBay.DocumentationPortal -Version 2.0.2
<PackageReference Include="EngineBay.DocumentationPortal" Version="2.0.2" />
paket add EngineBay.DocumentationPortal --version 2.0.2
#r "nuget: EngineBay.DocumentationPortal, 2.0.2"
// Install EngineBay.DocumentationPortal as a Cake Addin #addin nuget:?package=EngineBay.DocumentationPortal&version=2.0.2 // Install EngineBay.DocumentationPortal as a Cake Tool #tool nuget:?package=EngineBay.DocumentationPortal&version=2.0.2
EngineBay.DocumentationPortal
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 | Versions 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. |
-
net8.0
- EngineBay.Core (>= 9.0.0)
- Microsoft.Extensions.FileProviders.Embedded (>= 7.0.14)
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 | 144 | 1/30/2024 |
2.0.5 | 196 | 1/10/2024 |
2.0.4 | 170 | 12/20/2023 |
2.0.3 | 121 | 12/14/2023 |
2.0.2 | 145 | 12/7/2023 |
2.0.1 | 161 | 11/29/2023 |
2.0.0 | 150 | 11/23/2023 |
1.0.7 | 164 | 11/8/2023 |
1.0.6 | 119 | 11/2/2023 |
1.0.5 | 118 | 11/2/2023 |
1.0.4 | 134 | 11/1/2023 |
1.0.3 | 219 | 10/31/2023 |
1.0.2 | 132 | 10/31/2023 |
1.0.1 | 125 | 10/10/2023 |
1.0.0 | 229 | 9/28/2023 |
0.2.0 | 125 | 9/27/2023 |
0.1.1 | 133 | 9/26/2023 |
0.1.0 | 148 | 9/26/2023 |