Skip to content

Commit e7e68fa

Browse files
runnabrorunnabro
authored
chore: unblock releases update docs (#1268)
[![PR App][icn]][demo] | Fix RM-XYZ :-------------------:|:----------: ## 🧰 Changes Can't release b/c front matter format needs to be updated ahhhhh ## 🧬 QA & Testing - [Broken on production][prod]. - [Working in this PR app][demo]. [demo]: https://markdown-pr-PR_NUMBER.herokuapp.com [prod]: https://SUBDOMAIN.readme.io [icn]: https://user-images.githubusercontent.com/886627/160426047-1bee9488-305a-4145-bb2b-09d8b757d38a.svg
1 parent 5859571 commit e7e68fa

File tree

12 files changed

+87
-54
lines changed

12 files changed

+87
-54
lines changed

‎docs/callouts.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2-
title: 'Callouts'
3-
category: 5fdf7610134322007389a6ed
4-
hidden: false
2+
title: Callouts
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
55
metadata:
66
image:
7-
0: 'https://files.readme.io/9134da7-rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png'
8-
1: 'rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png'
9-
2: 530
10-
3: 173
11-
4: '#edf3ec'
7+
'0': >-
8+
https://files.readme.io/9134da7-rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png
9+
'1': rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png
10+
'2': 530
11+
'3': 173
12+
'4': '#edf3ec'
13+
privacy:
14+
view: public
1215
---
1316

1417
## Syntax

‎docs/code-blocks.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: 'Code Blocks'
3-
category: 5fdf7610134322007389a6ed
4-
hidden: false
2+
title: Code Blocks
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
5+
privacy:
6+
view: public
57
---
68

79
## Examples

‎docs/custom-css.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
2-
title: "Custom Styling"
3-
category: 5fdf7610134322007389a6ec
4-
excerpt: "Styling best-practices and CSS selector references."
5-
hidden: false
2+
title: Custom Styling
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ec
5+
content:
6+
excerpt: Styling best-practices and CSS selector references.
7+
privacy:
8+
view: public
69
---
710
By and large, the new markdown processor outputs standard HTML. This means most basic CSS element selectors will continue to work seamlessly. Depending on how complex your Markdown and custom CSS are, you should only have to update a few styles here and there!
811

‎docs/embeds.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: "Embeds"
3-
category: 5fdf7610134322007389a6ed
4-
hidden: false
2+
title: Embeds
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
5+
privacy:
6+
view: public
57
---
68

79
## Syntax

‎docs/features.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
2-
title: 'And more...'
3-
category: 5fdf7610134322007389a6ed
4-
excerpt: 'Additional Markdown features of the ReadMe platform implementation.'
5-
hidden: false
2+
title: And more...
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
5+
content:
6+
excerpt: Additional Markdown features of the ReadMe platform implementation.
7+
privacy:
8+
view: public
69
---
710

811
We've also built a lot of great features right in to the ReadMe app, which work on top of our markdown engine to give your developers a best-in-class documentation experience. These features aren't all baked in to the new engine itself, but they're worth mentioning nonetheless!

‎docs/getting-started.md‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
---
2-
title: "Getting Started"
3-
category: 5fdf7610134322007389a6ec
4-
excerpt: "ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of magic."
5-
hidden: false
6-
metadata:
7-
title: "ReadMe-Flavored Markdown"
8-
description: "ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of magic."
9-
image:
10-
0: "https://files.readme.io/aafdc0b-share-image"
11-
1: "share-image"
12-
2: 600
13-
3: 315
14-
4: "#2caaf8"
2+
title: Getting Started
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ec
5+
metadata:
6+
title: ReadMe-Flavored Markdown
7+
description: >-
8+
ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of
9+
magic.
10+
image:
11+
'0': 'https://files.readme.io/aafdc0b-share-image'
12+
'1': share-image
13+
'2': 600
14+
'3': 315
15+
'4': '#2caaf8'
16+
content:
17+
excerpt: >-
18+
ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of
19+
magic.
20+
privacy:
21+
view: public
1522
---
1623
[<img src=https://github.com/readmeio/markdown/workflows/CI/badge.svg align=right style="margin-top: 3px; margin-bottom: 3px;" />](https://www.npmjs.com/package/@readme/markdown) A remark-based Markdown engine for parsing and rendering ReadMe docs. (In fact, you're looking at it right now, since we've used it to render every doc in this project!)
1724

‎docs/headings.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: 'Headings'
3-
category: 5fdf7610134322007389a6ed
4-
hidden: false
2+
title: Headings
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
5+
privacy:
6+
view: public
57
---
68

79
## Examples

‎docs/images.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: "Images"
3-
category: 5fdf7610134322007389a6ed
4-
hidden: false
2+
title: Images
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
5+
privacy:
6+
view: public
57
---
68
## Syntax
79
```

‎docs/lists.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: "Lists"
3-
category: 5fdf7610134322007389a6ed
4-
hidden: false
2+
title: Lists
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
5+
privacy:
6+
view: public
57
---
68

79
[block:api-header]

‎docs/mermaid.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: 'Mermaid Diagrams'
3-
category: 5fdf7610134322007389a6ed
4-
hidden: false
2+
title: Mermaid Diagrams
3+
category:
4+
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
5+
privacy:
6+
view: public
57
---
68

79
## Examples

0 commit comments

Comments
 (0)