NormandErwan / DocFxForUnity

DocFX usage example for Unity projects
https://normanderwan.github.io/DocFxForUnity/
MIT License
213 stars 31 forks source link

No Index.md included in sample #22

Closed SimonDarksideJ closed 1 year ago

SimonDarksideJ commented 2 years ago

When cloning this sample and running "docfx documentation\docfx.json --serve", the generated site does not resemble what is shown on the example github pages site.

This seems to be because the Index.md that is mentioned in the docfx config is missing from the sample

NormandErwan commented 2 years ago

Apologies for the late answer. The Documentation/index.md is missing indeed because I copy it from README.md.

It's step 9 of the section Setup your documentation in the readme.

It's also included in the GitHub Action line 21.

I didn't want to maintain two files nor I found a way to synchronize them except by this manual copy.