Skip to content

Commit

Permalink
Merge pull request #394 from vordgi/rd-392
Browse files Browse the repository at this point in the history
rd-392 support github styled blockquotes
  • Loading branch information
vordgi authored Nov 13, 2024
2 parents beafa14 + 0f46fd3 commit 4c5fd0e
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/01-getting-started/02-writing-md.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
43 changes: 43 additions & 0 deletions docs/04-build-in/01-blockquotes.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions docs/04-build-in/README.md
Original file line number Diff line number Diff line change
@@ -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_
2 changes: 1 addition & 1 deletion packages/robindoc/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "robindoc",
"version": "2.5.0",
"version": "2.5.1",
"description": "",
"main": "./lib/index.js",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion packages/robindoc/src/assets/base.scss
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down

0 comments on commit 4c5fd0e

Please sign in to comment.