Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hideoo/starlight-typedoc

Starlight plugin to generate documentation from TypeScript using TypeDoc
https://github.com/hideoo/starlight-typedoc

astro documentation plugin starlight typedoc typescript

Last synced: 5 days ago
JSON representation

Starlight plugin to generate documentation from TypeScript using TypeDoc

Host: GitHub
URL: https://github.com/hideoo/starlight-typedoc
Owner: HiDeoo
License: mit
Created: 2023-06-07T14:35:09.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-12-17T08:52:46.000Z (about 1 month ago)
Last Synced: 2025-01-18T08:08:49.159Z (12 days ago)
Topics: astro, documentation, plugin, starlight, typedoc, typescript
Language: TypeScript
Homepage: https://starlight-typedoc.vercel.app
Size: 1.52 MB
Stars: 75
Watchers: 2
Forks: 9
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  starlight-typedoc 📚

  Starlight plugin to generate documentation from TypeScript using TypeDoc.

  

    

      

    

  





  

    

  

  

    

  

  




## Getting Started

Want to get started immediately? Check out the [getting started guide](https://starlight-typedoc.vercel.app/getting-started/) or check out the [demo](https://starlight-typedoc-example.vercel.app) to see the plugin in action.

## Features

A [Starlight](https://starlight.astro.build) plugin using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown) to generate documentation from TypeScript code.

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/starlight-typedoc/blob/main/LICENSE) for more information.