Skip to content

API docs for the semver NuGet package

Notifications You must be signed in to change notification settings

WalkerCodeRanger/semver-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Semver NuGet Package Docs

This repository generates the docs for the semver NuGet package (github.com/maxhauser/semver). The docs are published via GitHub pages to semver-nuget.org.

Building

The docs are generated using docfx via a cake build script. Cake is set up in the repository directory as a dotnet tool. Use dotnet tool restore to download it before running the first time. A basic build can be run from the command line using:

dotnet cake

To serve the docs locally, run:

dotnet cake --target=serve

Project Structure

The source code of the semver project is imported via a git submodule in the src/ directory. API metadata is generated into the vX.Y.Z/ directory, but is not committed. The actual documentation site is generated into and served from the docs/ directory. Because GitHub pages cannot run cake or docfx, the docs/ directory is committed and GitHub pages serves it as a completely static site. Use dotnet cake before committing the docs/ directory to ensure it is clean.

About

API docs for the semver NuGet package

Resources

Stars

Watchers

Forks