From 893742d90e2e8e9f4743db1875e3d75e9db1c091 Mon Sep 17 00:00:00 2001 From: BearToCode Date: Mon, 22 Jan 2024 18:45:57 +0100 Subject: [PATCH 01/54] docs: add community plugins in README and docs --- README.md | 19 +++++ .../src/lib/components/link/PluginLink.svelte | 23 +++++ .../src/lib/components/sidebar/Sidebar.svelte | 9 +- docs/src/pages/community-plugins.svelte.md | 83 +++++++++++++++++++ docs/src/pages/introduction.svelte.md | 8 ++ docs/src/routes/+layout.svelte | 2 +- 6 files changed, 142 insertions(+), 2 deletions(-) create mode 100644 docs/src/lib/components/link/PluginLink.svelte create mode 100644 docs/src/pages/community-plugins.svelte.md diff --git a/README.md b/README.md index 3bf4ff6..4508e54 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,15 @@ Differently from most editors, Carta includes neither ProseMirror nor CodeMirror | [plugin-attachment](https://www.npmjs.com/package/@cartamd/plugin-attachment) | ![plugin-attachment](https://img.shields.io/npm/v/@cartamd/plugin-attachment) | [/plugins/attachment](https://beartocode.github.io/carta/plugins/attachment) | | [plugin-anchor](https://www.npmjs.com/package/@cartamd/plugin-anchor) | ![plugin-anchor](https://img.shields.io/npm/v/@cartamd/plugin-anchor) | [/plugins/anchor](https://beartocode.github.io/carta/plugins/anchor) | +## Community plugins + +| Plugin | Description | +| ----------------------------------------------------------------------------- | ---------------------------------- | +| [carta-plugin-video](https://github.com/maisonsmd/carta-plugin-video) | Render online videos | +| [carta-plugin-imsize](https://github.com/maisonsmd/carta-plugin-imsize) | Render images in specific sizes | +| [carta-plugin-subscript](https://github.com/maisonsmd/carta-plugin-subscript) | Render subscripts and superscripts | +| [carta-plugin-ins-del](https://github.com/maisonsmd/carta-plugin-ins-del) | `` and `` tags support | + # Getting started > [!WARNING] @@ -128,6 +137,7 @@ For the full documentation, examples, guides and more checkout the [website](htt - [Slash](https://beartocode.github.io/carta/plugins/slash) - [TikZ](https://beartocode.github.io/carta/plugins/tikz) - [Attachment](https://beartocode.github.io/carta/plugins/attachment) + - [Anchor](https://beartocode.github.io/carta/plugins/anchor) - API: - [Utilities](https://beartocode.github.io/carta/api/utilities) - [Core](https://beartocode.github.io/carta/api/core) @@ -148,3 +158,12 @@ npm run commit # or, if you have commitizen installed globally git cz ``` + +### Running docs + +If you want to preview the docs: + +``` +cd docs +npm run dev +``` diff --git a/docs/src/lib/components/link/PluginLink.svelte b/docs/src/lib/components/link/PluginLink.svelte new file mode 100644 index 0000000..a2892ff --- /dev/null +++ b/docs/src/lib/components/link/PluginLink.svelte @@ -0,0 +1,23 @@ + + + + + diff --git a/docs/src/lib/components/sidebar/Sidebar.svelte b/docs/src/lib/components/sidebar/Sidebar.svelte index a81ed88..f2f4edb 100644 --- a/docs/src/lib/components/sidebar/Sidebar.svelte +++ b/docs/src/lib/components/sidebar/Sidebar.svelte @@ -10,7 +10,8 @@ Link2, Slash, File, - FontStyle + FontStyle, + Stack } from 'radix-icons-svelte'; import SidebarLink from './SidebarLink.svelte'; @@ -46,6 +47,12 @@ Editing Styles + + + + Community Plugins + +

Plugins

diff --git a/docs/src/pages/community-plugins.svelte.md b/docs/src/pages/community-plugins.svelte.md new file mode 100644 index 0000000..ef0b3b7 --- /dev/null +++ b/docs/src/pages/community-plugins.svelte.md @@ -0,0 +1,83 @@ +--- +title: Community Plugins +section: Overview +--- + + + +Here are is a list of several plugins developed by the community: + + + +### `carta-plugin-subscript` + + + +> Adds ability to render online video from Youtube or Vimeo. + + + +``` +npm i carta-plugin-subscript +``` + + + + + +### `carta-plugin-imsize` + + + +> Adds ability to render images in specific sizes. + + + +``` +npm i carta-plugin-imsize +``` + + + + + +### `carta-plugin-ins-del` + + + +> `` and `` tags support + + + +``` +npm i carta-plugin-ins-del +``` + + + + + +### `carta-plugin-subscript` + + + +> Adds ability to render subscripts and superscripts. + + + +``` +npm i carta-plugin-subscript +``` + + diff --git a/docs/src/pages/introduction.svelte.md b/docs/src/pages/introduction.svelte.md index 6dfe2fd..e1cacd3 100644 --- a/docs/src/pages/introduction.svelte.md +++ b/docs/src/pages/introduction.svelte.md @@ -85,6 +85,14 @@ Carta comes with a set of official plugins for the most common use cases. + + + +Community Plugins +Explore plugins from the community. + + + ## Examples diff --git a/docs/src/routes/+layout.svelte b/docs/src/routes/+layout.svelte index 91e45c3..71950b5 100644 --- a/docs/src/routes/+layout.svelte +++ b/docs/src/routes/+layout.svelte @@ -24,6 +24,6 @@