https://github.com/trialanderrororg/reoff-markup-to-style
Plugin for `reoff` that is able to change the styles of paragraphs based on the markup of the underlying text
https://github.com/trialanderrororg/reoff-markup-to-style
abstract ast syntax tree unified
Last synced: 4 months ago
JSON representation
Plugin for `reoff` that is able to change the styles of paragraphs based on the markup of the underlying text
- Host: GitHub
- URL: https://github.com/trialanderrororg/reoff-markup-to-style
- Owner: TrialAndErrorOrg
- License: gpl-3.0
- Created: 2023-03-27T20:54:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-28T18:53:45.000Z (almost 2 years ago)
- Last Synced: 2025-08-09T07:27:09.795Z (10 months ago)
- Topics: abstract, ast, syntax, tree, unified
- Language: TypeScript
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
> **Note**
> This repository is automatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.
# reoff-markup-to-style
Plugin for `reoff` that is able to change the styles of paragraphs based on the markup of the underlying text
## Contents
- [reoff-markup-to-style](#reoff-markup-to-style)
- [Contents](#contents)
- [What is this?](#what-is-this)
- [When should I use this?](#when-should-i-use-this)
- [Install](#install)
- [Use](#use)
- [API](#api)
- [`default()`](#default)
- [Example](#example)
- [Signature](#signature)
- [Parameters](#parameters)
- [Returns](#returns)
- [`Options`](#options)
- [Example](#example-1)
- [Syntax tree](#syntax-tree)
- [Security](#security)
- [Related](#related)
- [Contribute](#contribute)
- [License](#license)
## What is this?
A plugin for `reoff` for finding paragraphs that have a certain markup in a `docx` document and changing their style to a different style.
## When should I use this?
If you want to change the style of paragraphs based on the markup of the underlying text.
If you want to change the style of paragraphs based on the markup of the underlying text, but are handling the `[ooxast][ooxast]` syntax tree yourself, use [ooxast-util-markup-to-style](https://github.com/TrialAndErrorOrg/ooxast-util-markup-to-style)
## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as
```bash
pnpm add reoff-markup-to-style
# or with yarn
# yarn add reoff-markup-to-style
# or with npm
# npm install reoff-markup-to-style
```
## Use
## API
---
### `default()`
`reoff` plugin for inferring paragraph styles from the markup of the underlying text.
By default, this plugin will infer the following styles:
- `w:b` -> `Heading 1`
- `w:i` -> `Heading 2`
This plugin can be configured to infer other styles as well.
#### Example
```ts
const options: Options = [
// find all paragraphs that are bold and larger than 24pt and make it a Title
{
markup: (rPr) => rPr['w:b'] && rPr['w:sz'] && rPr['w:sz']['w:val'] > 24,
style: 'Title',
},
// find all paragraphs that are strikethrough text and make it a Comment
{
markup: 'w:strike',
style: 'Comment',
},
]
```
#### Signature
```ts
default(options: Options = ...): ReturnType>;
```
#### Parameters
| Name | Type | Description |
| :-------- | :------------------------------ | :-------------- |
| `options` | [`Options`](modules.md#options) | Plugin options. |
#### Returns
`ReturnType`<`Plugin`<[`Options?`] | `void`[], `Root`, `Root`>>
A reoff plugin.
Defined in: reoff/reoff-markup-to-style/src/lib/reoff-markup-to-style.ts:35
---
### `Options`
> `Option`[]
#### Example
```ts
const options: Options = [
// find all paragraphs that are bold and larger than 24pt and make it a Title
{
markup: (rPr) => rPr['w:b'] && rPr['w:sz'] && rPr['w:sz']['w:val'] > 24,
style: 'Title',
},
// find all paragraphs that are strikethrough text and make it a Comment
{
markup: 'w:strike',
style: 'Comment',
},
]
```
Defined in: [ooxast/ooxast-util-markup-to-style/src/lib/ooxast-util-markup-to-style.ts:80](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-markup-to-style/src/lib/ooxast-util-markup-to-style.ts#L80)
## Syntax tree
Uses the `[ooxast][ooxast]` syntax tree.
## Security
## Related
- [ooxast-util-markup-to-style](https://github.com/TrialAndErrorOrg/ooxast-util-markup-to-style)
## Contribute
## License
[GPL-3.0-or-later](LICENSE) © Thomas F. K. Jorna
[unified]: https://unifiedjs.com
[unifiedgh]: https://github.com/unifiedjs/unified
[xast-from-xml]: https://github.com/syntax-tree/xast-util-from-xml
[rehype]: https://github.com/rehypejs/rehype
[rejour]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour
[rejour-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-parse
[rejour-stringify]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-stringify
[rejour-move-abstract]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-move-abstract
[rejour-meta]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-meta
[rejour-relatex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-relatex
[relatex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex
[relatex-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/relatex-parse
[jast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jast
[jast-util-to-texast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jast-util-to-texast
[jastscript]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jastscript
[texast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/texast
[texast-util-to-latex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/texast-util-to-latex
[hast]: https://github.com/syntax-tree/hast
[xast]: https://github.com/syntax-tree/xast
[mdast]: https://github.com/syntax-tree/mdast
[mdast-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
[latex-utensils]: https://github.com/tamuratak/latex-utensils
[latexjs]: https://github.com/latexjs/latexjs
[reoff]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff
[reoff-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff/reoff-parse
[reoff-rejour]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff/reoff-rejour
[ooxast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/ooxast/ooxast
[ooxast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/ooxast/ooxast-util-to-jast
[reoff-markup-to-style]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff-markup-to-style