Docsify.js VS JSDoc

Docsify.js Reviews

JSDoc Reviews

Docsify.js mentions (17)

• Cookbook for SH-Beginners. Any interest? (building one)

  Okay new plan, does anyone know how to do this docsify on github? I obviously am a noob on github and recently on reddit. I'd like to help where I can but my knowlegde seems to be my handycap. I could provide you a trash-mail, if you need one, but I need a PO (product owner) to manage the git... I have no clue about this yet (pages and functions and stuff). Source: 10 months ago

• Cookbook for SH-Beginners. Any interest? (building one)

  Good idea. Instead of bookstack, I recommend something like Docsify The content is all in Markdown and can be managed in a git repo. Easy to deploy the whole website to any simple static HTTP server - or even Github pages. This way you can review contributions and have good version control. Source: 10 months ago

• Ask HN: Any Sugestions for Proceures Documentation?

  The tools to author it aren't that important, frankly. Ask your audience what they're most comfortable using and try to meet them there. If the stakeholders are technical, you have more options. If they aren't, I hope you like Google Docs or Word, because if you give them anything other than that or a PDF, they'll probably complain. At worst, yeah, write it in a long Markdown text file and use tools like pandoc to... - Source: Hacker News / about 1 year ago

• How to Build a Personal Webpage from Scratch (In 2022)

  Big fan of https://docsify.js.org since theres no need to compile your static site. A small amount of js just renders markdown. - Source: Hacker News / over 1 year ago

• Example of Support Guide for End Users

  If you are searching for examples of an arbitrary Jellyfin support site, visit https://travisflix.com/help/#/support (or help.travisflix.com which redirects to the /help/ URI of the TLD) to take a look at what I have done with docsify on Github Pages. Source: over 1 year ago

JSDoc mentions (48)

• Eloquent JavaScript 4th edition (2024)

  I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / about 2 months ago

• Add typing to your Javascript code (without Typescript, kinda) ✍🏼

  The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 2 months ago

• What is JSDoc and why you may not need typescript for your next project?

  There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app. - Source: dev.to / 3 months ago

• TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc

  JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools. - Source: dev.to / 4 months ago

• Adding a search feature to my app

  Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and... - Source: dev.to / 6 months ago