https://github.com/diplodoc-platform/components

https://github.com/diplodoc-platform/components

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/diplodoc-platform/components
• Owner: diplodoc-platform
• License: mit
• Created: 2020-04-29T13:20:42.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-06T15:18:37.000Z (about 2 months ago)
• Last Synced: 2024-11-06T15:31:58.772Z (about 2 months ago)
• Language: TypeScript
• Size: 3.32 MB
• Stars: 12
• Watchers: 21
• Forks: 22
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
[![NPM version](https://img.shields.io/npm/v/@diplodoc/components.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/components)

# YFM Docs Components

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

## Installation

`npm i @diplodoc/components`

## Usage

Append js

```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(

    

        

    ,

);

```

Append css

```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](https://www.python.org/downloads/release/python-2718/) to get the latest version.

Install Dependencies

```shell

npm ci

cd demo && npm ci

```

To start the development server with storybook run the following:

```shell

npm run dev

```

## License

MIT