plasma-infra: Scaffold docs dir CLI #1099
Conversation
| @@ -0,0 +1,25 @@ | |||
| --- | |||
| id: {{name}} | |||
There was a problem hiding this comment.
[Note]: будет подставлено название компонента, например Avatar
|
|
||
| ```tsx live | ||
| import React from 'react'; | ||
| import { {{name}} } from '@salutejs/{{package}}'; |
There was a problem hiding this comment.
[Note]: package - название пакета, например caldera.
|
Theme Builder app deployed! http://plasma.sberdevices.ru/pr/plasma-theme-builder-pr-1099/ |
| const indexSource = `import React from "react"; | ||
| import ReactDOM from "react-dom"; | ||
| import styled, { createGlobalStyle } from "styled-components"; | ||
| import { {{ theme }}__light } from "@salutejs/{{ vertical }}-themes"; |
There was a problem hiding this comment.
[Note]:
theme- конкретное название темы, напримерsdds_servvertical- дизайн вертикаль, напримерplasmaилиsdds
| import useIsBrowser from '@docusaurus/useIsBrowser'; | ||
| import { usePrismTheme, useColorMode } from '@docusaurus/theme-common'; | ||
| import { PlaygroundPreview } from '@salutejs/plasma-docs-ui'; | ||
| import { {{ theme }}__dark, {{ theme }}__light } from '@salutejs/{{ vertical }}-themes'; |
There was a problem hiding this comment.
[Note]:
theme- конкретное название темы, напримерsdds_servvertical- дизайн вертикаль, напримерplasmaилиsdds
Yakutoc
requested review from
Yeti-or,
neretin-trike and
kayman233
as code owners
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
There was a problem hiding this comment.
в интро не должно быть это либа такая то
токены такие-то
все дела?
There was a problem hiding this comment.
@Yeti-or Я тогда могу за шаблон взять пример из sdds-serv ?
There was a problem hiding this comment.
ну в целом мы можем это сделать отдельно, в sdds-serv нужно переписать на plasma-themes
There was a problem hiding this comment.
Давай тогда в задаче про генерацию содержимого для компонентов
There was a problem hiding this comment.
Вы имеете в виду доку? Потому что если вы про либу, то она уже использует sdds-themes пакет
Yakutoc
force-pushed
the
chore-docs-scaffold
branch
from
95e3053 to
62cc58f
Compare
|
Theme Builder app deployed! http://plasma.sberdevices.ru/pr/plasma-theme-builder-pr-1099/ |
Yakutoc
force-pushed
the
chore-docs-scaffold
branch
from
3daeb54 to
6187ff2
Compare
|
Theme Builder app deployed! http://plasma.sberdevices.ru/pr/plasma-theme-builder-pr-1099/ |
| const { Scaffold } = require('simple-scaffold'); | ||
| const path = require('path'); | ||
| const { ensureDir } = require('fs-extra'); | ||
| const { readdir } = require('node:fs/promises'); |
There was a problem hiding this comment.
минор
А просто readdirSync не подойдет?
There was a problem hiding this comment.
@neretin-trike А какие бенефиты?
Yakutoc
force-pushed
the
chore-docs-scaffold
branch
from
6187ff2 to
cb8509a
Compare
|
Theme Builder app deployed! http://plasma.sberdevices.ru/pr/plasma-theme-builder-pr-1099/ |
Scaffold docs CLI
What/why changed
Автоматизация развертывания документации для новых пакетов/дизайн вертикалей.
theme- конкретное название темы, напримерsdds_servvertical- дизайн вертикаль, напримерplasmaилиsddsurl- что будет в конце URL -plasma.sberdevices.ru/asdk/Создаст документацию
plasma-asdk-docsдля пакетаplasma-asdk.