JSDoc Reviews

Markdown by DaringFireball Reviews

JSDoc mentions (51)

• 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 / 20 days 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 / 21 days ago

• Figma's Journey to TypeScript

  You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead. It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are. Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript. [1] https://jsdoc.app/. - Source: Hacker News / about 1 month ago

• 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 / 3 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 / 4 months ago

Markdown by DaringFireball mentions (79)

• Marp: A Markdown Presentation App That Simplifies Your Tech Talks

  In today's fast-paced tech world, giving effective presentations is crucial for conveying complex ideas and engaging audiences. While Markdown has emerged as a popular lightweight markup language for creating rich text documents, its use in creating dynamic, interactive, and visually appealing presentations can be challenging. This is where Marp comes into the picture - an open-source Markdown presentation app... - Source: dev.to / 3 months ago

• I turned my open-source project into a full-time business

  It's just CommonMark, Gruber was ticked off enough that he declined to allow them to use the term Markdown at all. Alone among the variations, or nearly so, he's fine (as your link indicates) with Git-Flavored Markdown. The thing is, they didn't fork it, they decided to "standardize" it. John Gruber had already published a Markdown standard: https://daringfireball.net/projects/markdown/, and a reference... - Source: Hacker News / 3 months ago

• SN Pro Typeface

  Aha that's just an inline footnote, we support both in Supernotes. So you can quickly write ^[Name of Reference] (that will auto assign it the number 1 once rendered) rather than [^1] ... [1]: Name of Reference. Footnotes aren't part of the original Markdown specification (https://daringfireball.net/projects/markdown/). - Source: Hacker News / 3 months ago

• Creating a static Next.js 14 Markdown Blog - An Adventure

  Markdown is a text markup language. It's widely adapted. For example, github repo's will detect the readme.md file in the current directory and display it below. - Source: dev.to / 5 months ago

• A View on Functional Software Architecture

  Note, that this file is a Markdown and YAML file at the same time, and as such human- and machine-readable, if the fields are filled carefully. - Source: dev.to / 6 months ago