Skip to main content

Editing Docs

Most documentation pages live in the docs/ folder.

Each page is written in Markdown or MDX:

docs/intro.mdx
docs/using-streetsdocs/editing-docs.mdx
docs/server-hosting/live-server.mdx

Basic Page Format​

Use front matter at the top of a page to control the page title:

---
title: My Page Title
---

# My Page Title

Write the page content here.

Headings​

Use headings to break pages into sections:

# Page Title

## Main Section

### Smaller Section

Code Blocks​

Use fenced code blocks for commands and examples:

```bash
npm run build
```

Link to another doc page with a relative path:

[Publishing Updates](./publishing-updates)

Link to an external site with a full URL:

[GitHub](https://github.com/keeepitrunninup/StreetsDocs)

Images​

Images that should be public can go in static/img/.

Reference them like this:

![Description](/img/example.png)

The sidebar is controlled by sidebars.js.

When adding a new page, add its doc id to the sidebar so people can find it from the left navigation.