@diplodoc/components
Advanced tools
Компоненты для Yandex Flavored Markdown Documentation.
npm i @diplodoc/components
Append js
// In most cases append transform runtime
import "@doc-tools/transform/dist/js/yfm.js";
// 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, ...}
})
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';
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
MIT
FAQs
React components for drawing Diplodoc documentation
The npm package @diplodoc/components receives a total of 267 weekly downloads. As such, @diplodoc/components popularity was classified as not popular.
We found that @diplodoc/components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.