diff --git a/docs/src/demos/Marks/TextStyle/index.spec.js b/docs/src/demos/Marks/TextStyle/index.spec.js new file mode 100644 index 00000000..e5e31a5b --- /dev/null +++ b/docs/src/demos/Marks/TextStyle/index.spec.js @@ -0,0 +1,5 @@ +context('/api/marks/text-style', () => { + before(() => { + cy.visit('/api/marks/text-style') + }) +}) diff --git a/docs/src/docPages/api/extensions/font-family.md b/docs/src/docPages/api/extensions/font-family.md index 09171211..08c86b2a 100644 --- a/docs/src/docPages/api/extensions/font-family.md +++ b/docs/src/docPages/api/extensions/font-family.md @@ -1,18 +1,24 @@ # FontFamily +This extension enables you to set the font family in the editor. ## Installation ::: warning Use with TextStyle -This extension requires the [`TextStyle`](/api/nodes/text-style) mark. +This extension requires the [`TextStyle`](/api/marks/text-style) mark. ::: ```bash # with npm -npm install @tiptap/extension-font-family +npm install @tiptap/extension-text-style @tiptap/extension-font-family # with Yarn -yarn add @tiptap/extension-font-family +yarn add @tiptap/extension-text-style @tiptap/extension-font-family ``` +## Settings +| Option | Type | Default | Description | +| ------ | ----- | ------------- | --------------------------------------------------------------------- | +| types | array | ['textStyle'] | A list of marks where the font family attribute should be applied to. | + ## Source code [packages/extension-font-family/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-font-family/) diff --git a/docs/src/docPages/api/marks/text-style.md b/docs/src/docPages/api/marks/text-style.md index 8c5fce5e..9c1aaac0 100644 --- a/docs/src/docPages/api/marks/text-style.md +++ b/docs/src/docPages/api/marks/text-style.md @@ -1,5 +1,5 @@ # Text Style -This mark renders a `` HTML tag and enables you to add a list of styling related attributes, for example font-family, font-size, or font-color. The extension doesn’t add any styling attribute by default, but other extensions use it as the foundation, for example `FontFamily`. +This mark renders a `` HTML tag and enables you to add a list of styling related attributes, for example font-family, font-size, or font-color. The extension doesn’t add any styling attribute by default, but other extensions use it as the foundation, for example [`FontFamily`](/api/extensions/font-family). ## Installation ```bash diff --git a/docs/src/links.yaml b/docs/src/links.yaml index dd20f5a4..ed2b93f5 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -132,6 +132,7 @@ link: /api/extensions/focus - title: FontFamily link: /api/extensions/font-family + draft: true - title: Gapcursor link: /api/extensions/gapcursor - title: History