Skip to content

Commit 715140c

Browse files
authored
docs(docs): clarify slug handling (#491)
1 parent 8dc217a commit 715140c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

documentation/rdme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ If you're anything like us...
4747

4848
The only required attributes are the `title` and `category`. To determine what your `category` value should be, you can use [the `Get all categories` endpoint](https://docs.readme.com/reference/getcategories) and grab the `id` value from the response.
4949

50-
We automatically derive the page's slug via the file name (e.g. the file name `rdme.md` would become `/docs/rdme` in your ReadMe project), but you can override that as well:
50+
We automatically derive the page's slug via the file name (e.g. the file name `rdme.md` would become `/docs/rdme` in your ReadMe project). Note that our API uses [`slugify`](https://www.npmjs.com/package/slugify) to automatically handle certain characters (e.g. spaces), which may lead to unexpected syncing behavior if your file names don't match your page slugs. If you prefer to keep your page slugs different from your file name, you can manually set the slug value in the YAML front matter:
5151

5252
```markdown
5353
---

0 commit comments

Comments
 (0)