diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 482308138..9738ecea7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -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 diff --git a/docs/callouts.md b/docs/callouts.md index 71591ef0a..6c90a6f29 100644 --- a/docs/callouts.md +++ b/docs/callouts.md @@ -1,14 +1,17 @@ --- -title: 'Callouts' -category: 5fdf7610134322007389a6ed -hidden: false +title: Callouts +category: + uri: syntax 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 diff --git a/docs/code-blocks.md b/docs/code-blocks.md index 078c5c94d..64b5df30e 100644 --- a/docs/code-blocks.md +++ b/docs/code-blocks.md @@ -1,7 +1,9 @@ --- -title: 'Code Blocks' -category: 5fdf7610134322007389a6ed -hidden: false +title: Code Blocks +category: + uri: syntax +privacy: + view: public --- ## Examples diff --git a/docs/custom-css.md b/docs/custom-css.md index 86aaca226..b5e3c6396 100644 --- a/docs/custom-css.md +++ b/docs/custom-css.md @@ -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! diff --git a/docs/embeds.md b/docs/embeds.md index 48a271258..52272f7bb 100644 --- a/docs/embeds.md +++ b/docs/embeds.md @@ -1,7 +1,9 @@ --- -title: "Embeds" -category: 5fdf7610134322007389a6ed -hidden: false +title: Embeds +category: + uri: syntax +privacy: + view: public --- ## Syntax diff --git a/docs/features.md b/docs/features.md index 08f0c2288..58b205358 100644 --- a/docs/features.md +++ b/docs/features.md @@ -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! diff --git a/docs/getting-started.md b/docs/getting-started.md index cc9ed372a..85004a83f 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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 --- [](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!) diff --git a/docs/headings.md b/docs/headings.md index 5d1952919..06f8b006e 100644 --- a/docs/headings.md +++ b/docs/headings.md @@ -1,7 +1,9 @@ --- -title: 'Headings' -category: 5fdf7610134322007389a6ed -hidden: false +title: Headings +category: + uri: syntax +privacy: + view: public --- ## Examples diff --git a/docs/images.md b/docs/images.md index 20bc90db0..a792a4b1e 100644 --- a/docs/images.md +++ b/docs/images.md @@ -1,7 +1,9 @@ --- -title: "Images" -category: 5fdf7610134322007389a6ed -hidden: false +title: Images +category: + uri: syntax +privacy: + view: public --- ## Syntax ``` diff --git a/docs/lists.md b/docs/lists.md index 7f1dc4519..df3ddfaaa 100644 --- a/docs/lists.md +++ b/docs/lists.md @@ -1,7 +1,9 @@ --- -title: "Lists" -category: 5fdf7610134322007389a6ed -hidden: false +title: Lists +category: + uri: syntax +privacy: + view: public --- [block:api-header] diff --git a/docs/mermaid.md b/docs/mermaid.md index 601cea1eb..4c8968145 100644 --- a/docs/mermaid.md +++ b/docs/mermaid.md @@ -1,7 +1,9 @@ --- -title: 'Mermaid Diagrams' -category: 5fdf7610134322007389a6ed -hidden: false +title: Mermaid Diagrams +category: + uri: syntax +privacy: + view: public --- ## Examples diff --git a/docs/syntax-extensions.md b/docs/syntax-extensions.md index e72eb02bc..b9b35d7f6 100644 --- a/docs/syntax-extensions.md +++ b/docs/syntax-extensions.md @@ -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 --- diff --git a/docs/tables.md b/docs/tables.md index cda1aeb87..b9a9cb8b4 100644 --- a/docs/tables.md +++ b/docs/tables.md @@ -1,7 +1,9 @@ --- -title: 'Tables' -category: 5fdf7610134322007389a6ed -hidden: false +title: Tables +category: + uri: syntax +privacy: + view: public --- ## Syntax