This is an unpublished draft preview that might include content that is not yet approved. The published website is at w3.org/WAI/.

Create and Edit Documents

New resources

To create a new repository, follow the instructions in Creating a New Resource.

To create a new page in an existing repository:

Design Components and Style Guide

Changelogs

There are two main purposes for changelogs:

  1. To help update a translated resource.
  2. To inform people of substantive changes to a resource.

What to include in the changelog depends on translation status:

Write the changelog primarily to support updating translations. To help others find substantive changes, include “significant” in the heading and list the changes in bold. For example, changelog for Standards page.

Example and some explanation

This is probably the most bare bones example of a document:

The area between the two lines of three dashes (---) is called “Frontmatter”. It contains all the meta-information for the page and everything that is usually not visible in the content of the page.

Here, the title will be used in the (HTML) page title, and as an <h1>. the permalink will set where a document can be reached on the WAI website, here: https://www.w3.org/WAI/some/path/ – it is relative from /WAI/.

The ref is equal to the permalink in English resources, translated resources have a different permalink but the same ref as in English. That allows us to refer to a page regardless of translation. lang sets the language.

Everything after the second line of three dashes is Markdown (or HTML) content and output in the content area of the document. That is the area you are reading right now. Hello!

Back to Top

This is an unpublished draft preview that might include content that is not yet approved. The published website is at w3.org/WAI/.