From 06992ad4f8cbec7fa4fa4947f51261d46ee755ec Mon Sep 17 00:00:00 2001 From: Vordgi Date: Wed, 13 Nov 2024 16:51:06 +0400 Subject: [PATCH 1/3] rd-392 release 2.5.1 --- packages/robindoc/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/robindoc/package.json b/packages/robindoc/package.json index 7f89338c..1ab969d8 100644 --- a/packages/robindoc/package.json +++ b/packages/robindoc/package.json @@ -1,6 +1,6 @@ { "name": "robindoc", - "version": "2.5.0", + "version": "2.5.1", "description": "", "main": "./lib/index.js", "scripts": { From 4ee19ae44ef12f2e762b8de4ee6b4dcd06d3b992 Mon Sep 17 00:00:00 2001 From: Vordgi Date: Wed, 13 Nov 2024 17:01:23 +0400 Subject: [PATCH 2/3] rd-392 update white-space style --- packages/robindoc/src/assets/base.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/robindoc/src/assets/base.scss b/packages/robindoc/src/assets/base.scss index d17fbbca..f5d9bfce 100644 --- a/packages/robindoc/src/assets/base.scss +++ b/packages/robindoc/src/assets/base.scss @@ -53,7 +53,7 @@ body { overflow: hidden auto; scroll-padding-top: calc(var(--header-height) + 20px); scrollbar-color: var(--r-neutral-400) var(--r-neutral-200); - white-space: pre; + white-space: pre-wrap; @media screen and (width < $sm) { scroll-padding-top: calc(var(--header-height) + 60px); From 0f46fd37d57eb55d075ae24015aac5ebe102eded Mon Sep 17 00:00:00 2001 From: Vordgi Date: Wed, 13 Nov 2024 17:04:29 +0400 Subject: [PATCH 3/3] rd-392 describe blockquotes --- docs/01-getting-started/02-writing-md.md | 2 +- docs/04-build-in/01-blockquotes.md | 43 ++++++++++++++++++++++++ docs/04-build-in/README.md | 13 +++++++ 3 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 docs/04-build-in/01-blockquotes.md create mode 100644 docs/04-build-in/README.md diff --git a/docs/01-getting-started/02-writing-md.md b/docs/01-getting-started/02-writing-md.md index ae8d5bfe..4bfd713b 100644 --- a/docs/01-getting-started/02-writing-md.md +++ b/docs/01-getting-started/02-writing-md.md @@ -7,7 +7,7 @@ In addition to standard Markdown-to-HTML conversion, Robindoc automatically hand - Inserts images (_public images will use their direct URLs, while private images will be inserted via blob URLs_); - Embeds HTML/JSX (_Robindoc supports markup in both MDX and MD files_). -## Components Usage +## JSX Components All custom components should be passed to the page manually via props. This means that components do not need to be imported inside Markdown files. This approach provides maximum flexibility for all of Robindoc's features. diff --git a/docs/04-build-in/01-blockquotes.md b/docs/04-build-in/01-blockquotes.md new file mode 100644 index 00000000..cdc3b3de --- /dev/null +++ b/docs/04-build-in/01-blockquotes.md @@ -0,0 +1,43 @@ +# Blockquotes + +`blockquote` is a standard markdown element that allows you to highlight text or quote information + +```md +> Basic information that is additional or related to the main text. +``` + +> Basic information that is additional or related to the main text. + +Robindoc additionally supports the [GitHub alerts format](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts). This way you can highlight important information more clearly. + +```md +> [!NOTE] +> Useful information that users should know, even when skimming content. + +> [!TIP] +> Helpful advice for doing things better or more easily. + +> [!IMPORTANT] +> Key information users need to know to achieve their goal. + +> [!WARNING] +> Urgent info that needs immediate user attention to avoid problems. + +> [!CAUTION] +> Advises about risks or negative outcomes of certain actions. +``` + +> [!NOTE] +> Useful information that users should know, even when skimming content. + +> [!TIP] +> Helpful advice for doing things better or more easily. + +> [!IMPORTANT] +> Key information users need to know to achieve their goal. + +> [!WARNING] +> Urgent info that needs immediate user attention to avoid problems. + +> [!CAUTION] +> Advises about risks or negative outcomes of certain actions. diff --git a/docs/04-build-in/README.md b/docs/04-build-in/README.md new file mode 100644 index 00000000..143a51ab --- /dev/null +++ b/docs/04-build-in/README.md @@ -0,0 +1,13 @@ +# Build-in blocks + +Robindoc provides several built-in extensions for markdown. + +Since the framework is focused specifically on markdown. This makes it possible to maintain the same style for all platforms. The user can quickly view the original files, and then use the full documentation site. And in both cases he will receive all the necessary information. + +However, in all non-standard situations you can [use JSX](../01-getting-started/02-writing-md.md). + +## Current extensions + +- [Blockquotes](./01-blockquotes.md) + +- _Documentation under development_