Skip to content

chore: unblock releases update docs #1268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
runnabro merged 1 commit into from
Dec 12, 2025
Merged

chore: unblock releases update docs #1268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions docs/callouts.md
View file
Open in desktop
Copy link
Member

@erunion erunion Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where did these frontmatter changes come from? manual or rdme? rdme should be able to automatically migrate these over and the shape of metadata.image looks very off for rdme@10.

Copy link
Member

@erunion erunion Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah ok if rdme says it's good

Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
title: 'Callouts'
category: 5fdf7610134322007389a6ed
hidden: false
title: Callouts
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
metadata:
image:
0: 'https://files.readme.io/9134da7-rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png'
1: 'rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png'
2: 530
3: 173
4: '#edf3ec'
'0': >-
https://files.readme.io/9134da7-rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png
'1': rdmd.readme-stage-pr-2438.readme.ninja_docs_callouts.png
'2': 530
'3': 173
'4': '#edf3ec'
privacy:
view: public
---

## Syntax
Expand Down
8 changes: 5 additions & 3 deletions docs/code-blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: 'Code Blocks'
category: 5fdf7610134322007389a6ed
hidden: false
title: Code Blocks
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
privacy:
view: public
---

## Examples
Expand Down
11 changes: 7 additions & 4 deletions docs/custom-css.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Custom Styling"
category: 5fdf7610134322007389a6ec
excerpt: "Styling best-practices and CSS selector references."
hidden: false
title: Custom Styling
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ec
content:
excerpt: Styling best-practices and CSS selector references.
privacy:
view: public
---
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!

Expand Down
8 changes: 5 additions & 3 deletions docs/embeds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Embeds"
category: 5fdf7610134322007389a6ed
hidden: false
title: Embeds
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
privacy:
view: public
---

## Syntax
Expand Down
11 changes: 7 additions & 4 deletions docs/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: 'And more...'
category: 5fdf7610134322007389a6ed
excerpt: 'Additional Markdown features of the ReadMe platform implementation.'
hidden: false
title: And more...
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
content:
excerpt: Additional Markdown features of the ReadMe platform implementation.
privacy:
view: public
---

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!
Expand Down
33 changes: 20 additions & 13 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
---
title: "Getting Started"
category: 5fdf7610134322007389a6ec
excerpt: "ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of magic."
hidden: false
metadata:
title: "ReadMe-Flavored Markdown"
description: "ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of magic."
image:
0: "https://files.readme.io/aafdc0b-share-image"
1: "share-image"
2: 600
3: 315
4: "#2caaf8"
title: Getting Started
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ec
metadata:
title: ReadMe-Flavored Markdown
description: >-
ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of
magic.
image:
'0': 'https://files.readme.io/aafdc0b-share-image'
'1': share-image
'2': 600
'3': 315
'4': '#2caaf8'
content:
excerpt: >-
ReadMe's Markdown engine, with notes of GitHub, modern styles, and a hint of
magic.
privacy:
view: public
---
[<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!)

Expand Down
8 changes: 5 additions & 3 deletions docs/headings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: 'Headings'
category: 5fdf7610134322007389a6ed
hidden: false
title: Headings
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
privacy:
view: public
---

## Examples
Expand Down
8 changes: 5 additions & 3 deletions docs/images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Images"
category: 5fdf7610134322007389a6ed
hidden: false
title: Images
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
privacy:
view: public
---
## Syntax
```
Expand Down
8 changes: 5 additions & 3 deletions docs/lists.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Lists"
category: 5fdf7610134322007389a6ed
hidden: false
title: Lists
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
privacy:
view: public
---

[block:api-header]
Expand Down
8 changes: 5 additions & 3 deletions docs/mermaid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: 'Mermaid Diagrams'
category: 5fdf7610134322007389a6ed
hidden: false
title: Mermaid Diagrams
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
privacy:
view: public
---

## Examples
Expand Down
11 changes: 7 additions & 4 deletions docs/syntax-extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Flavored Syntax"
category: 5fdf7610134322007389a6ec
excerpt: "Specs and examples of ReadMe's (restrained) Markdown syntax extensions."
hidden: false
title: Flavored Syntax
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ec
content:
excerpt: Specs and examples of ReadMe's (restrained) Markdown syntax extensions.
privacy:
view: public
---
Custom Blocks
---
Expand Down
8 changes: 5 additions & 3 deletions docs/tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: 'Tables'
category: 5fdf7610134322007389a6ed
hidden: false
title: Tables
category:
uri: uri-that-does-not-map-to-5fdf7610134322007389a6ed
privacy:
view: public
---

## Syntax
Expand Down