2021-06-01 22:18:25 +08:00
# Subscript
[![Version ](https://img.shields.io/npm/v/@tiptap/extension-subscript.svg?label=version )](https://www.npmjs.com/package/@tiptap/extension-subscript)
[![Downloads ](https://img.shields.io/npm/dm/@tiptap/extension-subscript.svg )](https://npmcharts.com/compare/@tiptap/extension-subscript?minimal=true)
Use this extension to render text in < sub > subscript</ sub > . If you pass `<sub>` or text with `vertical-align: sub` as inline style in the editor’ s initial content, both will be normalized to a `<sub>` HTML tag.
## Installation
```bash
# with npm
npm install @tiptap/extension -subscript
# with Yarn
yarn add @tiptap/extension -subscript
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
2021-10-02 05:04:47 +08:00
| Command | Parameters | Description |
| --------------- | ---------- | ----------------------- |
2021-06-01 22:18:25 +08:00
| setSubscript | — | Mark text as subscript. |
| toggleSubscript | — | Toggle subscript mark. |
| unsetSubscript | — | Remove subscript mark. |
2021-06-09 17:57:54 +08:00
## Keyboard shortcuts
2021-10-02 05:04:47 +08:00
| Command | Windows/Linux | macOS |
| ----------------- | ------------------ | -------------- |
| toggleSubscript() | `Control` `,` | `Cmd` `,` |
2021-06-09 17:57:54 +08:00
2021-06-01 22:18:25 +08:00
## Source code
[packages/extension-subscript/ ](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-subscript/ )
## Usage
2021-08-26 05:10:20 +08:00
< tiptap-demo name = "Marks/Subscript" > < / tiptap-demo >