JSDoc
Next.js
Our great sponsors
JSDoc | Next.js | |
---|---|---|
67 | 2,042 | |
14,742 | 120,572 | |
0.8% | 1.6% | |
9.3 | 10.0 | |
5 days ago | 1 day ago | |
JavaScript | JavaScript | |
Apache License 2.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
JSDoc
-
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/
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
This is where JSDoc comes to save the day.
-
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:
-
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
-
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.
-
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 also does not cover many hidden use cases. It provides less than the bare minimum for what it needs to do - a lot of the time I am forced to rely on external user documentation elsewhere to use JSDoc effectively. That was why I was drawn to the search field in particular in Docusaurus.
-
JavaScript First, Then TypeScript
The Svelte team followed suit but motivated by the maintainer's developer experience as they migrated the project away from TypeScript in favor of plain JSDoc comments for type annotations instead.
-
No comments. Now what?
Even more relevant, tools like Javadoc, JSDoc, Doxygen, etc. read comments in a specific format to generate documentation. These comments do not affect readability. On the contrary, Javadocs are great for explaining how to use these entities. Combined with tools like my dear Doctest, we even get guarantees of accuracy and correctness!
-
The Complete 2023 Guide to Learning TypeScript - From Beginner to Advanced
Document types with JSDoc annotations
-
My opinionated JavaScript package template repository - zero config, start immediately
๐ JSDoc for documentation and jsdoc-to-markdown to create docs as markdown files
Next.js
-
System & Database Design (Day 1) - Creating a SaaS Startup in 30 Days
Next.js: For the website and the admin dashboard
-
Runtime environmental variables in Next.js 14
Until the time of writing, there is no official example of how to enable runtime environmental variables in a Dockerized Next.js app, as utilizing unstable_noStore would only dynamically evaluate variables on the server (node.js runtime). There is also an interesting discussion regarding this topic on GitHub.
-
@matstack/remix-adonisjs VS Next.js - a user suggested alternative
2 projects | 24 Apr 2024
next.js is a very popular React framework. remix-adonisjs includes more functionality through the AdonisJS backend ecosystem, and should be easier to self-host and self-manage.
-
Meet Cheryl Murphy: Full-Stack Developer, lifelong learner, and volunteer Project Team Lead at Web Dev Path
Cheryl Murphy is not only a dedicated full-stack web developer skilled in technologies like React, Next.js, and NestJs but also a community-driven professional who recently took on the role of volunteer project team lead at Web Dev Path. With a dual Bachelor's degree in Computing and Chemical Engineering from Monash University, Cherylโs journey in tech is marked by a passion for building accessible solutions and a commitment to fostering community within tech.
-
Ensuring Type Safety in Next.js Routing
For more information, check out this issue.
-
Styling Your Site with Next.js and MUI: Creating a Dynamic Theme Switcher
Remember to start the Next.js server with pnpm dev.
- Mastering Next.js 13/14 - Advanced Techniques
- 3 Exciting Improvements Between NextJS 14 And NextJS 13
-
The best testing setup for frontends, with Playwright and NextJS
We want to share with you the best testing setup we've experienced - and this includes using Playwright and NextJS. It's a setup we've come up with for Infinite React DataGrid, which is a complex component, with lots of things to test, but this configuration has helped us ship with more confidence and speed.
-
React 19: The long-expected features
If you're acquainted with NextJs, the directives will come as no surprise.
What are some alternatives?
ESDoc - ESDoc - Good Documentation for JavaScript
vite - Next generation frontend tooling. It's fast!
documentation.js - :book: documentation for modern JavaScript
Express - Fast, unopinionated, minimalist web framework for node.
Docusaurus - Easy to maintain open source documentation websites.
SvelteKit - web development, streamlined
apiDoc - RESTful web API Documentation Generator.
MERN - โ๏ธ DEPRECATED - Boilerplate for getting started with MERN stack
YUIDoc - YUI Javascript Documentation Tool
Angular - Deliver web apps with confidence ๐
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
fastify - Fast and low overhead web framework, for Node.js