DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-12 13:28:33 +00:00
Code Issues Releases Wiki Activity
Artemis/docfx
History
Robert f86383fdfd API docs - Fixed margin on mobile 
[skip ci]
2021-04-07 21:59:04 +02:00
..
docfx_project
API docs - Fixed margin on mobile
2021-04-07 21:59:04 +02:00
readme.md
Create readme.md
2020-11-02 20:17:22 +01:00

readme.md

To generate the Artemis API docs we use DocFX.

To build locally run the following commands from this folder.

Want to build? Follow these instructions (Windows)

  1. Ensure you can build the Artemis solution as per the main build instructions
  2. Install DocFX (with Chocolatey: choco install docfx)
  3. Open PowerShell in <repo>\docfx (the same folder as this readme file)
  4. Run docfx .\docfx_project\docfx.json to build static files
    Run docfx .\docfx_project\docfx.json --serve to serve locally