Skip to content

fix: update rdme now that this is on superhub #1061

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

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

fix: update rdme now that this is on superhub #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0674f42
fix: update rdme now that this is on superhub
mjcuva Feb 28, 2025
d3e705a
use pinned version of next
mjcuva Feb 28, 2025
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
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,6 @@ jobs:
# Sync docs to rdmd.readme.io
#
- name: Sync docs to rdmd.readme.io
uses: readmeio/rdme@v9
uses: readmeio/rdme@v10.2.0-next.4
with:
rdme: docs ./docs --key=${{ secrets.RDME_KEY }} --version=2
rdme: docs upload ./docs --key=${{ secrets.RDME_KEY }} --version=2
Copy link
Member

Choose a reason for hiding this comment

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

i heard rumblings that we're consolidating these docs into the main project but i believe this API key points to the markdown project!

19 changes: 11 additions & 8 deletions docs/callouts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
title: 'Callouts'
category: 5fdf7610134322007389a6ed
hidden: false
title: Callouts
category:
uri: syntax
metadata:
Copy link
Member

Choose a reason for hiding this comment

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

have you tried syncing locally? i thiiiink this metadata object shape this might cause issues with APIv2

Copy link
Member Author

Choose a reason for hiding this comment

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

Oof yeah I tried this and it broke the markdown repo really bad (with no warning). I had to setup bidi and do a git revert from there to fix it.

Copy link
Member

Choose a reason for hiding this comment

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

😬 yikes okay let me know if you need a hand! and if you have more info on what the breakage was, i'm happy to look into it! our API is rather strict about request payloads now so i would have expected it to throw rather than accept this and break stuff 😮‍💨

for add'l background, with the end of january sprint on this docs upload release, i didn't include metadata object in the initial list of fields to have migration logic for but i did create a test todo in the rdme repo to eventually backfill it. sounds like we should add that soon 🫠

Copy link
Member Author

Choose a reason for hiding this comment

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

This is the revert commit! https://github.com/readmeio/rdmd-docs/commit/8a1c29f0075e3a6eb3aa7b539fab2dec1a3cef0d

The big thing I think was the Syntax and syntax folders that got created for some reason. I also think some of the frontmatter that got created might have been invalid? Not sure

Copy link
Member

@kanadgupta kanadgupta Mar 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

ah okay — none of the diff looks frontmatter-related so not sure. i suppose this repo is pretty much the worst case scenario when it comes to MDX issues since the whole point of these docs is to demonstrate and test the limits of our markdown support 🫠 we deemed MDX issues out-of-scope for this rdme release but might be good to explore in the future!

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: syntax
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: markdown-engine
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: syntax
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: syntax
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: markdown-engine
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: syntax
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: syntax
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: syntax
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: syntax
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: markdown-engine
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: syntax
privacy:
view: public
---

## Syntax
Expand Down