From a58732436da35d4712194a7129fe640604955f9f Mon Sep 17 00:00:00 2001 From: d3m1d0v Date: Tue, 12 Nov 2024 14:08:25 +0300 Subject: [PATCH] docs: moved info about public css-variables to readme --- README.md | 61 ++++++++++++++++++++++++++++ README.ru.md | 61 ++++++++++++++++++++++++++++ src/transform/plugins/file/README.md | 54 ------------------------ 3 files changed, 122 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index 7ea64c7d..7b4a77e6 100644 --- a/README.md +++ b/README.md @@ -74,3 +74,64 @@ const { ## License MIT + +## CSS public variables + +**common** + +- `--yfm-color-text` +- `--yfm-color-link` +- `--yfm-color-base` +- `--yfm-color-link-hover` +- `--yfm-color-table` +- `--yfm-color-table-row-background` +- `--yfm-color-border` +- `--yfm-color-accent` + +**code** + +- `--yfm-color-inline-code` +- `--yfm-color-inline-code-background` +- `--yfm-color-code-background` + +**hightlight** + +- `--yfm-color-hljs-background` +- `--yfm-color-hljs-subst` +- `--yfm-color-hljs-comment` +- `--yfm-color-hljs-deletion` +- `--yfm-color-hljs-section` +- `--yfm-color-hljs-pseudo` +- `--yfm-color-hljs-literal` +- `--yfm-color-hljs-addition` +- `--yfm-color-hljs-meta` +- `--yfm-color-hljs-meta-string` + +**note** + +- `--yfm-color-note-tip` +- `--yfm-color-note-tip-background` +- `--yfm-color-note-warning` +- `--yfm-color-note-warning-background` +- `--yfm-color-note-important-background` +- `--yfm-color-note-info-background` + +**term** + +- `--yfm-color-term-title` +- `--yfm-color-term-title-hover` +- `--yfm-color-term-dfn-background` +- `--yfm-color-term-dfn-shadow` +- `--yfm-color-term-dfn-pseudo-shadow` + +**modal** + +- `--yfm-color-modal-content` +- `--yfm-color-modal-actions-hover` +- `--yfm-color-modal-wide-content` +- `--yfm-color-modal-wide-content-overlay` + +**file** + +- `--yfm-file-icon` +- `--yfm-file-icon-color` diff --git a/README.ru.md b/README.ru.md index 6466fe96..c99436c2 100644 --- a/README.ru.md +++ b/README.ru.md @@ -74,3 +74,64 @@ const { ## License MIT + +## Публичные CSS-переменные + +**common** + +- `--yfm-color-text` +- `--yfm-color-link` +- `--yfm-color-base` +- `--yfm-color-link-hover` +- `--yfm-color-table` +- `--yfm-color-table-row-background` +- `--yfm-color-border` +- `--yfm-color-accent` + +**code** + +- `--yfm-color-inline-code` +- `--yfm-color-inline-code-background` +- `--yfm-color-code-background` + +**hightlight** + +- `--yfm-color-hljs-background` +- `--yfm-color-hljs-subst` +- `--yfm-color-hljs-comment` +- `--yfm-color-hljs-deletion` +- `--yfm-color-hljs-section` +- `--yfm-color-hljs-pseudo` +- `--yfm-color-hljs-literal` +- `--yfm-color-hljs-addition` +- `--yfm-color-hljs-meta` +- `--yfm-color-hljs-meta-string` + +**note** + +- `--yfm-color-note-tip` +- `--yfm-color-note-tip-background` +- `--yfm-color-note-warning` +- `--yfm-color-note-warning-background` +- `--yfm-color-note-important-background` +- `--yfm-color-note-info-background` + +**term** + +- `--yfm-color-term-title` +- `--yfm-color-term-title-hover` +- `--yfm-color-term-dfn-background` +- `--yfm-color-term-dfn-shadow` +- `--yfm-color-term-dfn-pseudo-shadow` + +**modal** + +- `--yfm-color-modal-content` +- `--yfm-color-modal-actions-hover` +- `--yfm-color-modal-wide-content` +- `--yfm-color-modal-wide-content-overlay` + +**file** + +- `--yfm-file-icon` +- `--yfm-file-icon-color` diff --git a/src/transform/plugins/file/README.md b/src/transform/plugins/file/README.md index 953414f6..10c17df5 100644 --- a/src/transform/plugins/file/README.md +++ b/src/transform/plugins/file/README.md @@ -32,57 +32,3 @@ - `--yfm-file-icon` – sets custom file icon image - `--yfm-file-icon-color` – sets custom file icon color - - _common_ - -- `--yfm-color-text` -- `--yfm-color-link` -- `--yfm-color-base` -- `--yfm-color-link-hover` -- `--yfm-color-table` -- `--yfm-color-table-row-background` -- `--yfm-color-border` -- `--yfm-color-accent` - - _code_ - -- `--yfm-color-inline-code` -- `--yfm-color-inline-code-background` -- `--yfm-color-code-background` - - _hightlight_ - -- `--yfm-color-hljs-background` -- `--yfm-color-hljs-subst` -- `--yfm-color-hljs-comment` -- `--yfm-color-hljs-deletion` -- `--yfm-color-hljs-section` -- `--yfm-color-hljs-pseudo` -- `--yfm-color-hljs-literal` -- `--yfm-color-hljs-addition` -- `--yfm-color-hljs-meta` -- `--yfm-color-hljs-meta-string` - - _note_ - -- `--yfm-color-note-tip` -- `--yfm-color-note-tip-background` -- `--yfm-color-note-warning` -- `--yfm-color-note-warning-background` -- `--yfm-color-note-important-background` -- `--yfm-color-note-info-background` - - _term_ - -- `--yfm-color-term-title` -- `--yfm-color-term-title-hover` -- `--yfm-color-term-dfn-background` -- `--yfm-color-term-dfn-shadow` -- `--yfm-color-term-dfn-pseudo-shadow` - - _modal_ - -- `--yfm-color-modal-content` -- `--yfm-color-modal-actions-hover` -- `--yfm-color-modal-wide-content` -- `--yfm-color-modal-wide-content-overlay`