Found 168 pages:
| # | Page | Tags and summary |
|---|---|---|
| 1 | The MDN project | Landing, MDN Meta |
| MDN Web Docs is a wiki on which we document the open Web, Mozilla technologies, Firefox OS, and other developer topics. Anyone is welcome to add and edit content. You don't need to be a programmer or know a lot about technology; there are many different tasks that need to be performed, from the simple (proof-reading and correcting typos) to the complex (writing API documentation). | ||
| 2 | About MDN | Collaborating, Community, Copyright, Documentation, Guide, Licenses, MDN Meta |
| MDN Web Docs is an evolving learning platform for Web technologies and the software that powers the Web, including: | ||
| 3 | Linking to MDN | Guide, MDN Meta, Policy |
| We regularly get users asking us questions about how to link to MDN, or even if doing so is allowed. The short answer is: yes, you can link to MDN! For guidelines and recommendations on best practices, read on! | ||
| 4 | MDN Services | Landing, MDN Meta |
| MDN Services are experimental utilities for web developers designed to fit into existing workflows and help developers improve their web code. All MDN services are in early alpha stages of development, so we do not recommend relying on them for code quality assurance yet. If you like to experiment with prototypes, the services below are ready to try, and we would love to get your feedback on them. | ||
| 5 | Promote MDN | Guide, MDN Meta |
| Love MDN? Help share the open-Web goodness with fellow web developers by promoting MDN! We have some ideas of ways you can do that. We also have wallpapers, stickers, posters, animations, website badges, you name it; link to it from here. | ||
| 6 | Contributing to MDN | Guide, Landing, MDN Meta |
| The guides listed here cover all aspects of contributing to MDN, including style guides, guides to using our editor and tools, and more. Please make sure you have read (and are compliant with) the Mozilla Terms before editing or creating any pages. | ||
| 7 | Document structures | Landing, MDN Meta, Structures |
| Throughout MDN, there are various document structures that are used repeatedly, to provide consistent presentation of information in MDN articles. Here are articles describing these structures, so that, as an MDN author, you can recognize, apply, and modify them as appropriate for documents you write, edit, or translate. | ||
| 8 | Banners and notices | Guide, MDN Meta, Structures |
| Sometimes, an article needs a special notice added to it. This might happen if the page covers obsolete technology, or if it's about something experimental that shouldn't be used in production code. This article covers the most common such cases and what to do. | ||
| 9 | Compatibility tables | Guide, MDN Meta, Structures |
| We have standardized the appearance of compatibility tables for our open web documentation; that is, documentation of technologies such as the DOM, HTML, CSS, JavaScript, SVG, and so forth, that are shared across all browsers. | ||
| 10 | Live samples | Guide, Intermediate, MDN Meta, Structures |
| MDN supports turning sample code displayed in articles into running samples the reader can look at in action. These live samples can include HTML, CSS, and JavaScript in any combination. | ||
| 11 | A simple demo of a live code sample | Example, MDN Meta, Structures |
| This is a very simple example showing you how to do a live demo in MDN. For more information, see Live samples. | ||
| 12 | Macros | Guide, Kuma, KumaScript, MDN Meta, Structures |
| The Kuma platform on which MDN runs provides a powerful macro system, KumaScript, which makes it possible to do a wide variety of things automatically. This article provides information on how to invoke MDN's macros within articles. | ||
| 13 | Commonly-used macros | Reference, Structures |
| This page lists many of the general-purpose macros created for use on MDN. For how-to information on using these macros, see Using macros and Using link macros. | ||
| 14 | Other macros | Macros, Reference |
| In contrast to the macros listed in Commonly-used macros, the macros documented in this article are used infrequently or only in specific contexts, or are deprecated. | ||
| 15 | Page types | Guide, MDN Meta, Structures |
| There are a number of types of pages that are used repeatedly on MDN. This article describes these page types, their purposes, and gives examples of each. | ||
| 16 | Quicklinks | Guide, MDN Meta, Structures |
| MDN supports adding quicklinks to pages; these are boxes containing a potentially hierarchical list of links to other pages on MDN or to pages off-site. This article describes how to create quicklinks boxes. | ||
| 17 | Specification tables | Guide, MDN Meta, Structures |
| Every reference page on MDN should provide information about the specification or specifications in which that API or technology was defined. This article demonstrates what these tables look like and explains how to construct them. | ||
| 18 | Documentation processes | Landing, MDN Meta, MDN meta, Processes |
| The MDN documentation project is enormous; there are a vast number of technologies we cover through the assistance of hundreds of contributors from across the world. To help us bring order to chaos, we have standard processes to follow when working on specific documentation-related tasks. Here you'll find guides to those processes. | ||
| 19 | Cross-team collaboration tactics for documentation | Collaborating, Guide, MDN Meta, MDN meta, Processes |
| One thing that we've learned at MDN is that when the development team and the documentation team for a given project, API, or technology work closely—and well—together, the documentation quality is incredible. This guide offers some suggested tactics for how the developers and writers can work hand-in-hand. | ||
| 20 | Documentation bugs | Guide, MDN Meta, Processes |
| One of the main ways that that the MDN writing team gets requests for new documentation or documentation changes is through Bugzilla. This article describes how to use bugs to note when documentation updates are needed. | ||
| 21 | Documentation projects | MDN Meta, Planning |
| The MDN community sometimes is tasked with large documentation projects—that is, large amounts of documentation to be written or edited about a specific topic, or a large maintenance project to existing content. | ||
| 22 | MDN's agile process | Contribute, Documentation, MDN Meta, MDN meta, Process, documentation |
| The MDN staff team applies an agile process to prioritize and manage projects and tasks, for development of both MDN's content and its platform software (Kuma). The formalized framework that the MDN team's process most closely resembles is Scrum, with modifications to support both content and software development, within the context of Mozilla's Marketing department and its priorities. | ||
| 23 | Requesting elevated privileges | Guide, MDN Meta, Processes |
| Some tools or operations on MDN require elevated access privileges not available to ordinary users. | ||
| 24 | Guide to the MDN editor UI | Documentation, Guide, Landing, MDN, MDN Meta |
| The WYSIWYG (what-you-see-is-what-you-get) editor for the MDN Web Docs wiki makes it easy to contribute new content. This guide shows you how to use the editor and improve your productivity. Please read and comply with the Mozilla Terms before editing or creating new pages. | ||
| 25 | Editor UI elements | Beginner, Guide, MDN Meta, NeedsUpdate, editor |
| The built-in WYSIWYG editor on MDN is designed to make it as easy as possible to create, edit, and improve articles and other pages almost anywhere on the site. | ||
| 26 | Images | Guide, MDN Meta |
| It's frequently useful to include images in articles. Images may be screenshots, examples of what a rendering should look like, or SVG diagrams of program flow, for example. This article describes how to use images in MDN content. | ||
| 27 | Links | Documentation, Guide, MDC Project, MDN, MDN Meta |
| Links not only among many documents, but within a single document are a crucial component to any wiki, and MDN relies heavily on them. Fortunately, links are also very easy to create, even though there are lots of ways to make them! | ||
| 28 | Redirects | Guide, MDN Meta, MDN meta |
| Sometimes you need to have a page that simply redirects to another page, or to a section of another page. This article describes how to create redirects. | ||
| 29 | Source mode | Guide, Intermediate, MDN Meta |
| MDN's editor has a prominent button that gives you the ability to switch into source editing mode. In this mode, you see the underlying HTML for the body of the article you're editing. This guide will help you understand what you can do with this feature, what you should do with it, and, most importantly, what not to do. | ||
| 30 | Syntax highlighting | Guide, Howto, MDN Meta |
| When you add a code example to an article on MDN, it's helpful to enable syntax highlighting, to make it easy for readers to visually pick out relevant bits of the code. Here's how to enable syntax highlighting in code examples: | ||
| 31 | Tables | Guide, MDN Meta |
| Tables are a useful way to present information; this article covers how to create and maintain tables on MDN and when you should and should not use them. | ||
| 32 | Guidelines | Guidelines, Landing, MDN Meta |
| These guides provide details on how MDN documentation should be written and formatted, as well as how our code samples and other content should be presented. | ||
| 33 | Best practices | Documentation, Guide, Guidelines, MDN, MDN Meta |
| This article describes recommended ways of working with content on MDN. These guidelines describe preferred ways of doing things that lead to better results, or offer advice on deciding among multiple ways of doing similar things. | ||
| 34 | CSS style guide | Guidelines, MDN Meta, Styles |
| MDN has many built-in global styles available for use when styling and laying out articles — this article serves as a reference guide to what's available, explaining which styles are available and how to use each one. | ||
| 35 | Code sample guidelines | Guide, Guidelines, MDN Meta |
| The biggest advantage to adhering to these guidelines is that it will foster consistency across our samples and demos on MDN, which increases readability and comprehension overall. | ||
| 36 | Does this belong on MDN? | Guide, Guidelines, MDN Meta |
| If you're preparing to document something, you may be trying to decide whether to put the information on MDN. | ||
| 37 | Writing style guide | Documentation, Guide, Guidelines, MDN, MDN Meta |
| To present documentation in an organized, standardized, and easy-to-read manner, the MDN Web Docs style guide describes how text should be organized, spelled, formatted, and so on. These are guidelines rather than strict rules. | ||
| 38 | How-to guides | Landing, MDN Meta |
| These articles provide step-by-step guides to accomplishing specific goals when contributing to MDN. | ||
| 39 | How to be a beta tester | MDN Meta |
| From time to time, as the developers of MDN's Kuma platform make changes to the site, we provide early access to those new features to members who have opted in to be beta testers. As is typical with any "beta" test, features might not work properly in some situations. | ||
| 40 | How to convert code samples to be "live" | Beginner, Howto, MDN Meta |
| Live samples, which let you see what a sample's output looks like, make documentation more dynamic and instructive. This guide covers how to take existing samples and add "live" functionality to them. | ||
| 41 | How to create an MDN account | Beginner, Documentation, Guide, Howto, MDN Meta |
| To edit content on MDN, you need an MDN profile. You don't need a profile if you only want to read and search the MDN docs. This guide will help you set up your MDN profile. | ||
| 42 | How to create an interactive learning exercise | Guide, Howto, Intermediate, Learning, MDN Meta, MDN meta, Tutorial |
| When learning the web, it's important to rely on active learning content. Such content is made to help with learning something pro-actively. It can be exercises, live hackable examples, tasks to perform, assessments, etc. In short, anything that can help someone to actively understand something. | ||
| 43 | distant example | |