https://github.com/vertxxyz/NDocumentation
A documentation window for Unity Editor that displays rich text pages.
https://github.com/vertxxyz/NDocumentation
Last synced: about 1 year ago
JSON representation
A documentation window for Unity Editor that displays rich text pages.
- Host: GitHub
- URL: https://github.com/vertxxyz/NDocumentation
- Owner: vertxxyz
- License: mit
- Archived: true
- Created: 2018-12-02T02:05:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-03T10:46:55.000Z (over 7 years ago)
- Last Synced: 2024-11-10T15:46:04.398Z (over 1 year ago)
- Language: C#
- Size: 385 KB
- Stars: 14
- Watchers: 4
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- 3d-resources - NDocumentation
README
# nDocumentation
An extensible, searchable documentation window for the Unity Editor that displays rich text pages.
## 🚨 WORK IN PROGRESS AND HEAVILY EXPERIMENTAL 🚨
**Minimum Currently Supported Version : Unity 2019**
**2019.1.0a12 is not supported due to an issue with nested scroll views.**
**Currently recommended versions: 2019.1.0a13 or a14**
----
## Intended Use Case
Editor tools spread over multiple packages can rely on an nDocumentation window for documentation inside of the Unity Editor.
If a Documentation Page was defined in a core package, a package with a reliance on it can add additions to that Page's content. This enables a minimal amount of coherent pages whilst maintaining a high amount of documentation.
## Documentation
The provided nDocumentationExample package is self documenting, and contains a window present in Window>Example Window.
## Installation
Ensure your project is on .NET 4.x by navigating to Edit>Project Settings>Player>Configuration>Scripting Runtime Version and switching to .NET 4.x Equivalent.
Use the Package Manager (Window>Package Manager) and add the appropriate package.json files present in the root of each folder.
