@bootcamp-project/tsdoc-config

Ready-to-use TSDoc Configuration with TypeScript support by default

Usage no npm install needed!

<script type="module">
  import bootcampProjectTsdocConfig from 'https://cdn.skypack.dev/@bootcamp-project/tsdoc-config';
</script>

README

Ready-to-use TSDoc Configuration

with TypeScript and Svelte support by default

🦄 About 🦄

Description

Project Links

Minimum Viable Product: What is what we want?

  • What are the goals?
    • Goal #1
    • Goal #2
    • Goal #3
  • Sense (Why do these goals exist?)
    • Explanation #1
    • Explanation #2
    • Explanation #3
  • Purpose (What should be done with it?)
    • Use Case #1
    • Use Case #2
    • Use Case #3

🚀 Getting Started 🚀

💪 Installation 💪

npm install --safe-dev prettier @bootcamp-project/tsdoc-config
# or
yarn add --dev prettier @bootcamp-project/tsdoc-config

🤩 Usage 🤩

TBCP Best Practice

See TBCP default TSDoc settings

⭐️ Features ⭐️

😎 Built With 😎

TypeScript tbcp

🏆 Acknowledgements 🏆

Thanks for these awesome resources that were used during the development of the Bootcamp: TSDoc Configuration:

📑 Changelog 📑

See CHANGELOG for more information.

📋 Roadmap 📋

See the open issues for a list of proposed features (and known issues).

🤝 Contribute 🤝

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Please read the contribution guidelines first.

  1. Give us a star, it's really important! 😅
  2. Fork the Project: (git clone https://gitlab.com/the-bootcamp-project/configurations/tsdoc.git)
  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  4. Commit your Changes (git commit -m 'Add some AmazingFeature')
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request

📜 License 📜

See LICENSE for more information.

💌 Contact 💌

Bootcamp contributors - contributors @ bootcamp-project .com