TypeDoc Reviews

VuePress Reviews

TypeDoc mentions (14)

• Publish pure ESM npm package written in TypeScript to JSR

  JavaScript (TypeScript) ecosystem has various types of API docs generators. Maybe the most popular one is TypeDoc. While generating API docs itself is easy, hosting API docs is pretty hard. Publishing generated HTML to static hosting service like GitHub Pages is the method I adopted previously, but it's not an ideal solution because we can't view docs for older versions. - Source: dev.to / about 1 month ago

• Mastering JSDoc: the complete guide for Javascript developers

  Finally, JSDoc can be used to generate documentation for your code using tools like JSDoc itself and TypeDoc. These tools generate HTML or Markdown documentation based on your JSDoc annotations, making it easier for others to understand how your code works and how to use it. - Source: dev.to / about 1 year ago

• Opinionated standards for JSDoc

  Since you're using TypeScript, use TypeDoc. Source: about 1 year ago

• I created a game engine using TypeScript. Please roast it.

  I was thinking of using something like https://typedoc.org to do it, do you have experience with this sort of tools? Source: over 1 year ago

• How to properly document components

  JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool. Source: over 1 year ago

VuePress mentions (31)

• Free project idea - documentation framework!

  VuePress - when I searched if it's supporting what I want (conditional rendering), the first result is a bug issue opened 4 years ago, so it doesn't seem to be a good option. Source: about 1 year ago

• Using links in markdown to navigate files through directories.

  I'm new to IA Writer, and I'm wanting to use it to draft posts for my Vuepress site. Source: over 1 year ago

• Create a Static Site using VitePress for Beautiful Help Documentation

  VitePress is listed in the documents as VuePress' little brother, and it is built on top of Vite. For those that don't know Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects so it might sense to pair it with a static site generator such as VitePress. One of the original problems with VuePress was that it was a Webpack app and it took a lot of time to spin... - Source: dev.to / over 1 year ago

• Do you use Vue for smaller static sites?

  Definitely check out Vuepress for smaller static sites. We use it to publish our tutorials. Source: over 1 year ago

• Getting Tailwind to Work with Elm Book

  Trying to help build a design system at work in my spare time; no clue if it will go anywhere but it’s fun regardless. I asked the Elm Slack group what the equivalent of React Storybook. Specifically, I wanted a way to build a documentation website like Vuepress with the ability to host native Elm code to showcase components. They pointed me to Elm Book. While Elm Book has built-in theming capabilities, I needed... - Source: dev.to / over 1 year ago