Check out the Node.js API Documentation Redesign Preview

We've been rebuilding how Node.js generates and presents its API documentation, and a preview is now live at beta.docs.nodejs.org. Before it becomes the default, we want as many people as possible to use it for real work and tell us what you think.

What's different for readers

Like the current documentation, every page is generated from the same Markdown files in the nodejs/node repository that power the current docs. However, navigation, layout, and readability were all reworked so that finding and understanding an API takes less effort. On top of that, the beta adds things the current docs have never had, including offline-compatible search, an llms.txt file, and a modern overhaul of the visual identity to match the rest of the Node.js brand.

Under-the-hood

The redesigned documentation is built with doc-kit, a standalone tool developed by the Node.js Project to replace the previous, legacy, documentation generator.

For more information on doc-kit, and its capabilities for other projects, please refer to its repository. This will also be the place where any and all bug reports, feature requests, and other tasks should be tracked.

We need your feedback

While we are proud to state that the redesigned documentation is entering its final stage of development, feedback is still a crucial part of this migration, and we'd love to hear your thoughts on this process.

One important note: beta.docs.nodejs.org is a temporary address for this preview and will go away once the redesign becomes the default documentation. Please don't link to it from your own blog posts, tutorials, or other resources.

Acknowledgments

None of this would exist without the Node.js Web Team, whose members designed, built, and reviewed everything described in this post. Thanks as well to the Node.js community and the collaborators who have already helped by reviewing, testing, and making suggestions along the way. Thank you all for making this possible.