Skip to content

Commit

Permalink
docs: minor typo and formatting fix
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Apr 12, 2022
1 parent 715140c commit 6ea59ea
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/rdme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ If you're anything like us...

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.

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:
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 names, you can manually set the `slug` value in the YAML front matter:

```markdown
---
Expand Down

0 comments on commit 6ea59ea

Please sign in to comment.