https://github.com/dotbunny/gdx.dox

https://github.com/dotbunny/gdx.dox

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dotbunny/gdx.dox
• Owner: dotBunny
• License: bsl-1.0
• Created: 2022-04-22T13:56:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-24T18:47:25.000Z (over 2 years ago)
• Last Synced: 2024-11-08T04:15:16.248Z (2 months ago)
• Language: C#
• Size: 43 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GDX.Dox

This repository contains the tooling used to generate the documentation for [GDX](https://github.com/dotBunny/GDX).

Dox a [.NET 6](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) console application which adds context specific

functionality to the [DocFX](https://dotnet.github.io/docfx/) generation process. It explictly depends on an assumed

file structure found in the [GDX](https://github.com/dotBunny/GDX) package.

## Generate

The `--generate` argument will execute the logic required for parsing the API and generating the static content to be

served for documentation, by default it will spin up a hosting process as well.

> If no arguements are provided by default Dox will assume a `--generate` arguement has been passed.

## Deploy

The `--deploy` argument is used to create and push a GIT commit to a remote repository of the udpated documentation.