Skip to content

Commit b947131

Browse files
committed
chore: update README
add note to ensure any new docs pages do not include non-url safe characters in the file name or markdown id
1 parent a6bca1b commit b947131

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

website/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,10 @@ title: This Doc Needs To Be Edited
110110
My new content here..
111111
```
112112

113-
1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:
113+
Note: Ensure the file name and the id value do not include non-url safe
114+
characters i.e. '\*'.
115+
116+
2. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:
114117

115118
```javascript
116119
// Add newly-created-doc to the Getting Started category of docs
@@ -192,7 +195,7 @@ For more information about the navigation bar, click
192195

193196
1. Docusaurus uses React components to build pages. The components are saved as
194197
.js files in `website/pages/en`:
195-
1. If you want your page to show up in your navigation header, you will need to
198+
2. If you want your page to show up in your navigation header, you will need to
196199
update `website/siteConfig.js` to add to the `headerLinks` element:
197200

198201
`website/siteConfig.js`

0 commit comments

Comments
 (0)