Skip to content

Commit

Permalink
docs: remove unnecessary slug parameter, newlines
Browse files Browse the repository at this point in the history
As detailed in this comment: #173 (comment), the `slug` parameter in the frontmatter was only causing issues. `rdme` just looks at the filename to determine the slug, so the existence of the slug parameter here was just unnecessary duplicated information that has the potential to cause future syncing issues. I tested it locally with these changes and ran the command a bunch of times and confirmed that syncing works just fine without it.

Also I added newlines to the end of any files that were missing them!
  • Loading branch information
kanadgupta committed Jun 24, 2021
1 parent bb09a76 commit 8e0ac53
Show file tree
Hide file tree
Showing 15 changed files with 4 additions and 19 deletions.
1 change: 0 additions & 1 deletion docs/callout-tests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Callouts Tests"
category: 5fdf9fc9c2a7ef443e937315
slug: "callout-tests"
hidden: true
---

Expand Down
1 change: 0 additions & 1 deletion docs/callouts.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Callouts"
category: 5fdf7610134322007389a6ed
slug: "callouts"
hidden: false
metadata:
title: "Callouts — ReadMe-Favored Markdown"
Expand Down
1 change: 0 additions & 1 deletion docs/code-block-tests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Code Block Tests"
category: 5fdf9fc9c2a7ef443e937315
slug: "code-block-tests"
hidden: true
---
Basics
Expand Down
1 change: 0 additions & 1 deletion docs/code-blocks.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Code Blocks"
category: 5fdf7610134322007389a6ed
slug: "code-blocks"
hidden: false
---

Expand Down
1 change: 0 additions & 1 deletion docs/custom-css.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Custom Styling"
category: 5fdf7610134322007389a6ec
slug: "custom-css"
excerpt: "Styling best-practices and CSS selector references."
hidden: false
---
Expand Down
1 change: 0 additions & 1 deletion docs/embeds.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Embeds"
category: 5fdf7610134322007389a6ed
slug: "embeds"
hidden: false
---

Expand Down
3 changes: 1 addition & 2 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "And more..."
category: 5fdf7610134322007389a6ed
slug: "features"
excerpt: "Additional Markdown features of the ReadMe platform implementation."
hidden: false
---
Expand Down Expand Up @@ -40,4 +39,4 @@ This expands out to: “:sparkles: :owlbert-reading:”

## Known Issues

- Variable and glossary term expansions are rendered even when they've been manually escaped by the author.
- Variable and glossary term expansions are rendered even when they've been manually escaped by the author.
1 change: 0 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Getting Started"
category: 5fdf7610134322007389a6ec
slug: "getting-started"
excerpt: "ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of magic."
hidden: false
metadata:
Expand Down
3 changes: 1 addition & 2 deletions docs/headings.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Headings"
category: 5fdf7610134322007389a6ed
slug: "headings"
hidden: false
---
## Examples
Expand Down Expand Up @@ -50,4 +49,4 @@ For top-level headings, the underline notation is valid:
Occasionally, a single doc might contain multiple headings with the same text, which can cause the generated anchor links to conflict. ReadMe's new markdown processor normalizes heading anchors by auto-incrementing similar heading's IDs. Try it out by clicking on this section header _or_ the following sub-section title:

#### Incremented Heading Anchors
#### Incremented Heading Anchors
#### Incremented Heading Anchors
1 change: 0 additions & 1 deletion docs/images.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Images"
category: 5fdf7610134322007389a6ed
slug: "images"
hidden: false
---
## Syntax
Expand Down
1 change: 0 additions & 1 deletion docs/lists.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Lists"
category: 5fdf7610134322007389a6ed
slug: "lists"
hidden: false
---

Expand Down
3 changes: 1 addition & 2 deletions docs/syntax-extensions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Flavored Syntax"
category: 5fdf7610134322007389a6ec
slug: "syntax-extensions"
excerpt: "Specs and examples of ReadMe's (restrained) Markdown syntax extensions."
hidden: false
---
Expand Down Expand Up @@ -29,4 +28,4 @@ The engine also supports all standard markdown constructs, as well as CommonMark
- [**Lists**](doc:lists) <!-- Ordered and unordered lists; GFM-style checklists. -->
- [**Headings**](doc:headings) <!-- Supports setext, underline, and compact notations. -->
- [**Images**](doc:images)
- **Decorations** (link, strong, and emphasis tags, etc.)
- **Decorations** (link, strong, and emphasis tags, etc.)
1 change: 0 additions & 1 deletion docs/table-of-contents-tests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Table Of Contents Tests"
category: 5fdf9fc9c2a7ef443e937315
slug: "table-of-contents-tests"
hidden: true
---
# Variables (<<user>>)
Expand Down
1 change: 0 additions & 1 deletion docs/tables.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Tables"
category: 5fdf7610134322007389a6ed
slug: "tables"
hidden: false
---
## Syntax
Expand Down
3 changes: 1 addition & 2 deletions docs/variable-tests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Variable Tests"
category: 5fdf9fc9c2a7ef443e937315
slug: "variable-tests"
hidden: true
---
<<defvar>> and `<<defvar>>` and:
Expand All @@ -14,4 +13,4 @@ and

```js
const xyz = "<<defvar>>";
```
```

0 comments on commit 8e0ac53

Please sign in to comment.