Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.14 KB

README.md

File metadata and controls

30 lines (23 loc) · 1.14 KB

Description

This project consist of the emgage documentation.

How to run

Under Windows

Install from Nuget

  • Install Nuget.exe
  • Create a folder, e.g. C:\Tools\docfx, under the folder, nuget install docfx.console
  • Open command line:

or install via zip Download docfx.zip

Extract docfx.zip file to C:\Tools\docfx\docfx.console\tools

Test the documentation changes locally before publishing

set PATH=%PATH%;C:\Tools\docfx\docfx.console\tools
git checkout https://github.com/emgage/emgage-docs
docfx emgage-docs\docfx.json --serve

To access the local document changes, Open browser with http://localhost:8080/

Publish the document to learn.emgage.com

[Optional] Please execute the release Argocd - emgage-docs Now this deployment is auto triggered.

Docfx documentation

Please refere the official documentation of docfx tool