Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Latest commit

 

History

History
47 lines (33 loc) · 1.53 KB

File metadata and controls

47 lines (33 loc) · 1.53 KB
layout title description date
layouts/doc-post.njk
Add a doc
Add a doc to a documentation set.
2020-10-22

Clone the sample doc

Duplicate the example doc located in site/en/docs/_example/my-first-doc and copy the folder into your existing doc directory.

Rename the folder to match whatever slug you want to use for your doc url. For example, if you have an existing project at site/en/docs/cheese it would look like this:

├── docs
│   ├── cheese
│   │   ├── swiss
│   │   │   └── index.md

Add the doc to your project's table of contents

Follow the guide on adding your doc to an existing project's table of contents.

Get busy writing! 👩🏽‍💻

Docs support markdown syntax with some additional features and shortcodes. See the components guide for a full list of supported elements.

Uploading media 📸

developer.chrome.com uses an image CDN and GCS bucket to ensure that images and videos are served in a performant, responsive manner.

Take a look at the guide on uploading media to learn how to add images and videos to your docs.

Outdated banner

The outdated banner indicates this article is outdated and no longer accurate.

Set is_outdated field in your YAML frontmatter. If new material is available, paste an available content URL into the new_available_content_url field in your YAML frontmatter.