https://github.com/code-beans/unityfx
DocFX template to create Unity-esque documentation
https://github.com/code-beans/unityfx
docfx template unity3d
Last synced: 4 months ago
JSON representation
DocFX template to create Unity-esque documentation
- Host: GitHub
- URL: https://github.com/code-beans/unityfx
- Owner: code-beans
- License: mit
- Created: 2019-03-17T19:44:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-23T09:12:38.000Z (about 6 years ago)
- Last Synced: 2025-04-01T18:50:12.478Z (11 months ago)
- Topics: docfx, template, unity3d
- Language: JavaScript
- Size: 424 KB
- Stars: 41
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UnityFX
DocFX Template to create Unity-esque code documentation. [Demo](https://code-beans.github.io/UnityFX/articles/intro.html)
Based of the DocFX Material https://ovasquez.github.io/docfx-material/
## Changes from Default Template
- Full Width
- Custom _TIP_ alert
- Different colors
- Custom Breadcrumb
- Custom Sidebar
## How to use
0. install docfx
1. The template is contained in the _templates_ folder. Drop the entire folder into your root-level docfx project folder, next to your _api/_ and _articles/_ folders.
2. In your docfx.json (showing only relevant portion):
```json
{
"build": {
"template": [ "default", "templates/unity" ],
}
}
```
3. compile as you would using the default template
## Contribute
You are more than welcome to contribute. No code of conduct required, just be reasonable.
**Open TODOs:**
* Search in navbar
* table for `public` properties and fields
## Disclaimer
Notice of Non-Affiliation and Disclaimer
We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with Unity Technologies, or any of its subsidiaries, partners or its affiliates. The official Unity Technologies website can be found at https://unity.com/. "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere.