No TOC header visible in index.html - Githubissues

NormandErwan / DocFxForUnity

DocFX usage example for Unity projects

https://normanderwan.github.io/DocFxForUnity/

MIT License

213 stars 31 forks source link

No TOC header visible in index.html #21

Closed thefirstfloor closed 2 years ago

thefirstfloor commented 2 years ago

Hi, I'm totally new to this and figuring out how this could benefit our project. It looks very promising!

Downloaded the example Unity project and opened it in Unity 2020.3.3f1.

Upgraded the project
Copied readme.md to /Documentation folder as stated
Build documentation in Terminal in VScode.
Open page, no 'Manual', 'Scripting API' and 'Search' as shown here: https://normanderwan.github.io/DocFxForUnity/

Notes:

The /Documentation/api/ folder is generated and the files are in there.
Only get 1 warning when building (Invalid cref value "!:AudioClip" found in triple-slash-comments for HurtClip, ignored.)
In /_site/toc.html contains the correct HREF definitions.

Tried on Firefox, Edge, Chrome. Using Unity 2020.3.3f1

I feel like I'm just missing ONE thing somewhere.

thefirstfloor commented 2 years ago

The ONE thing was running it through a webserver apparently. Firefox & Chrome developer tools for the win.