content README

The project's README from github.com/mdn/content. As one markdown file: README.md.

Welcome to MDN Web Docs

github-profile

MDN Web Docs is an open-source, collaborative project that documents web technologies including CSS, HTML, JavaScript, and Web APIs. Alongside detailed reference documentation, we provide extensive learning resources for students and beginners getting started with web development.

MDN's mission

MDN's mission is to provide a blueprint for a better internet and empower a new generation of developers and content creators to build it.

The strength of MDN Web Docs lies in its vast community of active readers and contributors. Since 2005, approximately 45,000 contributors have created the documentation we know and love. Together, contributors have created over 45,000 documents that make up an up-to-date, comprehensive, and free resource for web developers worldwide.

In addition to English-language articles, over 35 volunteers lead translation and localization efforts for Chinese, French, Japanese, Korean, Portuguese, Russian, and Spanish.

Build the site

To set up the site locally, you need to have Node.js installed, which comes bundled with npm. You can check if these are installed by running the following commands:

node -v
npm -v

After you have installed Node.js, you can install the dependencies using npm install and start the local preview:

npm i
npm start

Once started, a live preview is available at http://localhost:5042/.

Contribute to MDN Web Docs

You can contribute to MDN Web Docs and be a part of our community through content contributions, engineering, or translation work. The MDN Web Docs project welcomes contributions from everyone who shares our goals and wants to contribute constructively and respectfully within our community.

To find out how to get started, see the CONTRIBUTING.md document in this repository. By participating in and contributing to our projects and discussions, you acknowledge that you have read and agree to our Code of Conduct, which means adhering to Mozilla's Community Participation Guidelines.

Get in touch

You can communicate with the MDN Web Docs team and community using the communication channels.

content (mdn/content)

Searching Database…

11.1K ·GitHub
Content
What is this?This is the official source repository for MDN Web Docs, containing over 14,000 pages of reference documentation and learning resources for HTML, CSS, JavaScript, HTTP, and Web APIs.
Is this a website codebase or just the content files?It is a content-only repository of Markdown documentation files; the actual site rendering is handled by separate tools (Rari/Fred) referenced in the build scripts.
How do I build and preview the docs locally?Install Node.js (which includes npm), run npm install to get dependencies, then start the local preview; it becomes available in your browser after starting.
What do I need installed to build the site?You need Node.js (version 24 or higher) installed, which comes bundled with npm.
Can I just edit a file and see live changes?Yes, once you run the local preview command the site updates live as you edit content files.
Who is this documentation aimed at?It targets both professional web developers needing reference docs and students/beginners who are just getting started with web development.
Is the content available in languages other than English?Yes, over 35 volunteers lead translation and localization efforts for Chinese, French, Japanese, Korean, Portuguese, Russian, and Spanish.
What topics does MDN cover besides HTML/CSS/JS?It also documents HTTP and Web APIs, alongside CSS, HTML, and JavaScript reference material.
What are similar projects?react.dev, solved-by-flexbox, curriculum, fe-interview, react-redux-links, awesome-angular, Web, zh-google-styleguide
Which topics is it in?translation, node, i18n, http, reference, css, documentation, html, learning, markdown, web-development, tutorial
Creator
mdn
Size
500.3 MB
Stars
11.1K
Updated
CommitOct 17
Age
6y
Commits · 90 Days