docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Adding a custom API landing page

    Add a file named api_index.md inside your Documentation~ folder. The Doc Tool picks this file up and uses it if one exists. Otherwise, it creates a default version with almost no information.

    This page is a good place to list the most important classes and other types in the API and to provide an overview.

    Example

    # API Reference
    
    ## Overview
    
    This is a custom API landing page. It can include links to the most important classes and other types in the API.
    
    ## Classes
    
    - [MyClass](xref:MyNamespace.MyClass): This is the main class.
    - [MyOtherClass](xref:MyNamespace.MyOtherClass): This is the other main class.
    
    ## Other Types
    
    - [MyEnum](xref:MyNamespace.MyEnum): This is an important enum used by Foo.
    - [MyStruct](xref:MyNamespace.MyStruct): This is an important struct used for Bar.
    - [MyInterface](xref:MyNamespace.MyInterface): This is an important interface used to implement Bazes.
    
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)