Skip to content

timunie/api-reference

 
 

Repository files navigation

Avalonia API-Reference

This project generates the Avalonia API reference documentation.

How it works

  • Avalonia is linked via .gitmodule for the given release branch
  • Sandcastle Help File Builder reads the Avalonia API info and generates MDX-files
  • Docusaurus uses the created MDX-files to generate a static website

How to build

It is important to mind the build order.

  1. build all Avalonia projects (you can use .\src\ApiDocumentation\DocumentationSources.slnx for this)
  2. build any custom SHFB plug-ins
  3. build the SHFB project
  4. build or preview the docs website

Note

Use the build.ps1 file to run the build. Usage:

# -preview: Add this switch if you want to open the preview of the website. If this switch is missing, an optimized build will be created .\build.ps1 -preview

Generate the API docs for newer Avalonia version

Use the set-version.ps1 script to update the version.

# -version: specify the Avalonia version to document. If this parameter is not set, `AvaloniaVersion.txt` will be used instead.  .\set-version.ps1 11.2.0 

Warning

Remember to commit all updates made to the submodule.

Known limitations

  • The API-Reference is only available for a single version as of now.
  • The search functionality is missing, but should be added soon.

About

API Reference Documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 70.5%
  • CSS 16.2%
  • JavaScript 5.9%
  • TypeScript 4.7%
  • PowerShell 2.2%
  • Shell 0.5%