undocs icon indicating copy to clipboard operation
undocs copied to clipboard

feat: `twoslash` support

Open cpreston321 opened this issue 1 year ago • 3 comments

🔗 Linked issue

❓ Type of change

  • [ ] 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
  • [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
  • [ ] 👌 Enhancement (improving an existing functionality like performance)
  • [x] ✨ New feature (a non-breaking change that adds functionality)
  • [ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Preview: https://feat-twoslash.undocs.pages.dev/guide/content-transformation#twoslash-code-blocks

This just a reference PR on how to enable it currently so we can test the waters.

📝 Checklist

  • [ ] I have linked an issue or discussion.
  • [ ] I have updated the documentation accordingly.

cpreston321 avatar Feb 26 '24 21:02 cpreston321

Deploying undocs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6fa41d0
Status: ✅  Deploy successful!
Preview URL: https://c171ed8c.undocs.pages.dev
Branch Preview URL: https://feat-twoslash.undocs.pages.dev

View logs

I really like this PR. I wanted to make a PR to integrate twoslash in h3 docs. Can't wait to have this !

DylanThomasFr avatar Apr 02 '24 18:04 DylanThomasFr

thanks for work on this. i think it would be a good addition but considering that this tool is still not stable and I'm trying to reduce stack size (#51), i would wait until changes (basically content layer rewrite) happen before considering twoslash support to make the migration easier.

pi0 avatar Apr 02 '24 19:04 pi0