4.15.5 • Published 9 months ago

@diplodoc/components v4.15.5

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

NPM version

YFM Docs Components

Компоненты для Yandex Flavored Markdown Documentation.

Installation

npm i @diplodoc/components

Usage

Append js

// In most cases append transform runtime
import "@doc-tools/transform/dist/js/yfm.js";

import {createRoot} from 'react-dom/client';
import {ThemeProvider} from '@gravity-ui/uikit';

// configure components
import {configure as configureUikit} from '@gravity-ui/uikit';
import {configure as configureDocs} from '@diplodoc/components';

configureUikit({lang: 'ru'});

// can be reconfigured in any moment
configureDocs({
    lang: 'ru',
    // optionally configure allowed translations
    loc: {ru, en, tr, ...}
})

// The theme must be applied. To do that wrap your app in ThemeProvider
const root = createRoot(document.getElementById('root'));
root.render(
    <ThemeProvider theme="light">
        <App />
    </ThemeProvider>,
);

Append css

/*project.css*/

/*Append components styles*/
@import '@diplodoc/components';

/*Append components theme*/
@import '@diplodoc/components/themes/common';

/*In most cases append transform styles*/
@import '@doc-tools/transform/dist/css/yfm.css';

Development

To build the project correctly you need to install python@2. Visit python.org/downloads to get the latest version.

Install Dependencies

npm ci
cd demo && npm ci

To start the development server with storybook run the following:

npm run dev

License

MIT

4.15.5

9 months ago

4.15.4

9 months ago

4.14.1

10 months ago

4.12.3

10 months ago

4.14.2

10 months ago

4.12.4

10 months ago

4.12.5

10 months ago

4.9.3

1 year ago

4.9.0

1 year ago

4.9.2

1 year ago

4.9.1

1 year ago

4.6.0

1 year ago

4.12.0

10 months ago

4.12.1

10 months ago

4.14.0

10 months ago

4.12.2

10 months ago

4.10.0

12 months ago

4.15.0

10 months ago

4.15.1

10 months ago

4.15.2

10 months ago

4.15.3

10 months ago

4.8.1

1 year ago

4.5.0

1 year ago

4.7.0

1 year ago

4.11.0

11 months ago

4.11.1

11 months ago

4.13.0

10 months ago

4.11.2

11 months ago

4.13.1

10 months ago

4.4.0

1 year ago

4.3.0

1 year ago

3.10.1

1 year ago

3.10.0

1 year ago

4.2.0

1 year ago

4.2.0-beta.0

1 year ago

4.1.0

1 year ago

4.0.0

1 year ago

3.10.0-beta.1

1 year ago

3.10.0-beta.0

1 year ago

3.9.1

1 year ago

3.9.0

1 year ago

3.8.0-beta.1

2 years ago

3.8.0

2 years ago

3.8.0-beta.0

2 years ago

3.7.0

2 years ago

3.6.0

2 years ago

3.5.1

2 years ago

3.5.0

2 years ago

3.4.0

2 years ago

3.3.1

2 years ago

3.3.0

2 years ago

3.2.0

2 years ago

3.1.0

2 years ago

3.0.5

2 years ago

3.0.4

2 years ago

3.0.3

2 years ago

3.0.2

2 years ago

3.0.1

2 years ago

3.0.0

2 years ago

3.0.0-alpha-8

2 years ago

3.0.0-alpha-7

2 years ago

3.0.0-alpha-6

2 years ago

3.0.0-alpha-5

2 years ago

3.0.0-alpha-4

2 years ago

3.0.0-alpha-3

2 years ago

3.0.0-alpha-2

2 years ago

3.0.0-alpha-1

2 years ago