typedoc
web.dev
typedoc | web.dev | |
---|---|---|
30 | 148 | |
7,398 | 3,547 | |
1.3% | - | |
9.1 | 9.0 | |
6 days ago | 2 months ago | |
TypeScript | Nunjucks | |
Apache License 2.0 | GNU General Public License v3.0 or later |
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.
typedoc
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
Firstly, install Typedoc using npm:
- Document Playwright tests with typedoc
-
90% less disk space + 80% faster doc generation w/ TypeDoc. Introducing the "Default Modern Theme" for TypeDoc + complete linkable API docs for the built-in TS lib declarations.
Background:The main bottleneck with the TypeDoc default theme especially for large projects is the verbose HTML for the left-hand navigation that linearly grows for each page based on the project size and consumes a massive amount of disk space; see this TypeDoc issue. The DMT caches the left-hand navigation HTML and dynamically creates a shared web component that is utilized across all pages only making a single copy of the navigation HTML. This reduces disk space utilization by up to 90% and also makes doc generation ~80% faster. I also include some style additions and replace the main search index generation using compressed MesssagePack instead of JSON which reduces the search index size by more than 90%.
-
Prim+RPC: a bridge between JavaScript environments. Easy-to-understand, type-safe, transport-agnostic RPC/IPC for JavaScript, supporting callbacks, batching, file uploads, custom serialization, and more.
While the Prim+RPC server is expected to be JavaScript, I'd like to support other languages through JSON Schema. I wrote a tool that translates TypeDoc comments into RPC-specific documentation. My plan is to turn this result into JSON Schema that can be served with the Prim+RPC server. This means you can get typed suggestions (for instance, from an IDE that understands JSON Schema) when writing requests in JSON files (I wrote a little about this here, still a WIP). From this, you could use your favorite HTTP client in the language of your choice, like but still benefit from having typed requests.
-
What software do you use to write documentation?
Docusaurus has a Typedoc plugin. Also there is a typedoc markdown plugin.
-
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.
-
Opinionated standards for JSDoc
Since you're using TypeScript, use TypeDoc.
-
How to create and publish a TypeScript library with ease
Generates HTML documentation using TypeDoc.
-
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?
-
Complete rewrite of ESLint (GitHub discussion by the creator)
TSDoc is more consistent, has cleaner documentation, better tooling (e.g. TypeDoc or ESLint plugin) and better support for data structures (e.g. straightforward enums support).
web.dev
-
Building a realtime chat app with Next.js and Vercel
Before we start creating pages in our application, it's important to understand how Next.js renders content. The framework supports multiple rendering methods including server-side rendering (SSR), static site rendering (SSG), and client-side rendering (CSR). There are many pros and cons to each rendering method (too many to cover in this post) so if these concepts are new to you, Google’s web.dev site has a very good introduction to rendering on the web that can help you understand rendering options.
-
Navigating the Waters of Core Web Vitals in 2024
The lifecycle of an interaction. Source: web.dev
-
How hard has code splitting been in your experience?
Probably not, it's the CSS used so far, so if there are elements you've not interacted with, that's an issue. This web.dev article gives some tools you can use https://web.dev/articles/extract-critical-css
-
Google have removed RSS support from their developer blogs
I noticed the same for Google's site https://web.dev/
The last article pushed to the feed was "Changes to the web.dev infrastructure" few months ago https://web.dev/blog/webdev-migration
The feed still there but with no updates https://web.dev/feed.xml and on the site you can see new articles published.
Is sad that on a infrastructure revamp of a modern site, the RSS feed was left out of the features list (at least for now).
-
How do websites have a prompt on unsupported browsers?
Upon testing on Firefox and Mi Browser, there was no triggering of the BeforeInstallPrompt event, as expected. However, I noticed that web.dev manages to display a prompt on these browsers, even though they theoretically lack support for the BeforeInstallPrompt event.
-
StackOverflow alternatives for web developers
web.dev, maintained by Google, including posts by Chrome developers and their co-workers,
-
Progressive vs. Incremental Rendering/(Re)Hydration
In a old web.dev articleI came across the word "Incremental (Re)Hydration" which is linked to a Glimmer.js-Blog post (also called "Incremental Rendering" there) confuses me. Is Incremental (Re)Hydration the same as Progressive (Re)Hydration? Reading the Glimmer-Blog article it seems so, but in the web.devarticle it seems to be something different.
-
Staying up to date with the industry with newsletters
Web.dev newsletter - though it's not a weekly newsletter and it's only content from web.dev (though really high quality content)
-
Is it possible to get into coding at 21 with no qualifications self taught?
Just open up a text edi web developers are self-taught. a website. That's what I did. Some people like this: https://web.dev
- Ya saben a donde anotarse si la quieren pegar en IT.
What are some alternatives?
tsdoc - A doc comment standard for TypeScript
vanilla-extract - Zero-runtime Stylesheets-in-TypeScript
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
lighthouse - Automated auditing, performance metrics, and best practices for the web.
VuePress - 📝 Minimalistic Vue-powered static site generator
TheAnnoyingSite.com - The Annoying Site a.k.a. "The Power of the Web Platform"
mkdocs-material - Documentation that simply works
lite-youtube-embed - A faster youtube embed.
docsify - 🃏 A magical documentation site generator.
bedrock - WordPress boilerplate with Composer, easier configuration, and an improved folder structure
Docusaurus - Easy to maintain open source documentation websites.