{"repo":"NormandErwan/DocFxForUnity","free":true,"listed":false,"github":"https://github.com/NormandErwan/DocFxForUnity","clone":"git clone https://github.com/NormandErwan/DocFxForUnity.git","description":"DocFX usage example for Unity projects","language":"C#","stars":241,"topics":["docfx","unity","unity3d","unity-documentation","gitlab"],"license":"MIT","category":"game-templates","readme_excerpt":"DocFX for Unity DocFX usage example for Unity projects DocFX tool generates a clean documentation that looks like the Unity documentation with a manual (written in Markdown) and a scripting API (from the C# scripts of the project). This repository contains a simple Unity example project which documentation is automatically generated and deployed online: . It references both C# API and Unity API. DocFxForUnity documentation manual :----------------------------------: DocFxForUnity documentation scripting API :----------------------------------: Setup your documentation 1. Install DocFX. 2. Copy the Documentation/ folder to your Unity project: You can rename Documentation/DocFxForUnity.csproj to match your project — just update the filename in Documentation/docfx.json under metadata[0].src[0].files accordingly. 3. Edit the following properties in Documentation/docfx.json , keep the others as it is: It's the configuration file of your documentation. See for more details. 4. Edit Documentation/filterConfig.yml : It tells DocFX which namespaces you want to generate the documentation. See for more details. 5. Document your classes and methods. See for more details. 6. (Optional) Add your manual pages: - Write a Markdown file for each page in Documentation/manual/ . - Keep a list of these pages on Documentation/manual/toc.yml . 7. (Optional) Add resources such as images: - Copy them to Documentation/resources/ . - Reference them on your docs or manual pages. - See for more details. ","default_branch":null,"files":null,"tree":[],"storefront":"/r/NormandErwan","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/NormandErwan/DocFxForUnity/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}