Repository files navigation

https://tsdoc.org/

• What is TSDoc? - project overview and roadmap
• Zulip chat room - live help from other developers
• TSDoc tag reference - learn about syntax elements such as@param,@remarks, etc.
• TSDoc Playground - interactive demo of the parser engine
• Contributing: Building the projects - how to build and debug the projects in this repo
• Contributing: Submitting a PR - instructions for making a pull request

Folder	Version	Changelog	Description
/api-demo	(local project)		Code samples illustrating how to use the@microsoft/tsdoc parser
/eslint-plugin		changelog	eslint-plugin-tsdoc plugin for ESLint
/playground	(local project)		Source code for theTSDoc Playground web app
/tsdoc		changelog	@microsoft/tsdoc parser library
/tsdoc-config		changelog	@microsoft/tsdoc-config loader fortsdoc.json

This project welcomes contributions and suggestions. Most contributions require you to agree to aContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant usthe rights to use your contribution. For details, visithttps://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to providea CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructionsprovided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ orcontactopencode@microsoft.com with any additional questions or comments.