JSDoc Reviews

Docsify.js Reviews

JSDoc mentions (54)

• Documenting Web Components With Storybook

  One of the best tools available in Web Component development is the Custom Elements Manifest. It's a JSON representation of all your available components, covering all the attributes, methods, slots and events they support, powered by your JSDoc comments and TypeScript types. You can customize the manifest generation through plugins to support custom JSDoc comments, allowing you to power more pieces of your... - Source: dev.to / 3 months ago

• Just Say No to JavaScript

  I've seen several ways of annotating Javascript that IDEs seem to understand. They usually involve using comments before fields, classes, or functions. The most compliant one seems to be using [JSDoc](https://jsdoc.app/). JSDoc is mostly intended for generating documentation. However, the Typescript compiler can validate types (and can even interoperate with Typescript definitions), if you configure it as such. In... - Source: Hacker News / 5 months ago

• TypeScript (and JSDoc) vs JavaScript

  If you choose to use JSDoc instead of TypeScript, this only con that TypeScript has is gone, but a new one appears: JSDoc doesnt work very well with more complex types if you dont use classes to represent them. - Source: dev.to / 7 months ago

• How to document your JavaScript package

  Thanks to JSDoc it's easy to write documentation that is coupled with your code and can be consumed by users in a variety of formats. When combined with a modern publishing flow like JSR, you can easily create comprehensive documentation for your package that not only fits within your workflow, but also integrates directly in the tools your users consume your package with. This blog post aims to cover best... - Source: dev.to / 12 months ago

• Deep Dive: Google Apps Script - Testing APIs and Automating Sheets

  Note: For simplicity, I will omit the JavaScript documentation, but for a production grade code you may want to add the documentation (see jsdoc.app website for more). - Source: dev.to / about 1 year ago

Docsify.js mentions (18)

• 🚀 Fast Static Site Deployment on AWS with Pulumi YAML

  I built a fast, responsive, and lightweight static documentation site powered by Docsify, hosted on AWS S3 with a CloudFront CDN for global distribution. The entire infrastructure is managed using Pulumi YAML, allowing me to declaratively define and deploy resources without writing any imperative code. - Source: dev.to / about 1 month ago

• 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: almost 2 years 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: almost 2 years 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 2 years 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 2 years ago