Skip to content
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.

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

chore(docs, demo): updated stories names, updated README #532

Merged
merged 1 commit into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .storybook/preview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const preview: Preview = {
},
options: {
storySort: {
order: ['Playground', 'Docs', 'Extensions', ['Presets', '*'], '*'],
order: ['Playground', 'Docs', 'Extensions', 'Settings', ['Presets', '*'], '*'],
},
},
controls: {
Expand Down
14 changes: 9 additions & 5 deletions README-ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ function Editor({onSubmit}) {
return <MarkdownEditorView stickyToolbar autofocus toaster={toaster} editor={editor} />;
}
```

Полезные ссылки:
- [Как подключить редактор в Create React App](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-install-create-react-app--docs)
- [Как добавить предварительный просмотр для режима разметки](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-develop-preview--docs)
Expand All @@ -61,7 +62,13 @@ function Editor({onSubmit}) {
- [Как добавить расширение GPT](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-connect-gpt--docs)
- [Как добавить расширение привязки текста в Markdown](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-develop-extension-with-popup--docs)

### Разработка

Для запуска Storybook в режиме разработки выполните следующую команду:

```shell
npm start
```

### i18n

Expand All @@ -77,10 +84,7 @@ configure({

Обязательно сделайте вызов `configure()` из [UIKit](https://github.com/gravity-ui/uikit?tab=readme-ov-file#i18n) и других UI-библиотек.

## Разработка

Для запуска Storybook в режиме разработки выполните следующую команду:
### Участие в разработке

```shell
npm start
```
- [Информация для контрибьюетров](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-contributing--docs)
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ Read more:
- [How to add GPT extension](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-connect-gpt--docs)
- [How to add text binding extension in markdown](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-develop-extension-with-popup--docs)

### Development
To start the dev storybook

```shell
npm start
```


### i18n
Expand All @@ -77,10 +83,6 @@ configure({

Don't forget to call `configure()` from [UIKit](https://github.com/gravity-ui/uikit?tab=readme-ov-file#i18n) and other UI libraries.

## Development
### Contributing

To start the dev storybook

```shell
npm start
```
- [Contributor Guidelines](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-contributing--docs)
2 changes: 1 addition & 1 deletion demo/stories/css-variables/CSSVariables.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ export const Story: StoryObj<typeof component> = {
Story.storyName = 'Custom CSS Variables';

export default {
title: 'Experiments / Custom CSS Variables',
title: 'Settings / Custom CSS Variables',
component,
};
2 changes: 1 addition & 1 deletion docs/how-to-add-editor-with-create-react-app.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Install / Create react app
##### Getting started / Create react app

## Installation Guide

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-add-editor-with-nextjs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Install / NextJS
##### Getting started / NextJS

## Connection and Configuration
This document provides instructions for configuring Webpack and Turbopack to avoid issues related to the 'fs' module and for connecting the editor on the nextjs client side.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-add-preview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Develop / Preview
##### Getting started / Preview

## How to Add Preview for Markup Mode

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-connect-gpt-extensions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Connect / GPT
##### Extensions / GPT

## How to connect GPT extensions to editor

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-connect-html-extension.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Connect / Html block
##### Extensions / Html block

## How to Connect the HTML Extension in the Editor

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-connect-latex-extension.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Connect / Latex extension
##### Extensions / Latex extension

## How to Connect the Latex Extension in the Editor

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-connect-mermaid-extension.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Connect / Mermaid Extension
##### Extensions / Mermaid Extension

## How to Connect the Mermaid Extension in the Editor

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-customize-the-editor.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##### Develop / Editor customization
##### Getting started / Editor customization

## How to customize the editor
You can use CSS variables to make editor contents fit your own needs
Expand Down
Loading