{"_id":"@171h/reoff-remark","_rev":"1-fb82834ebcc032a6a4f14a943649ce83","name":"@171h/reoff-remark","dist-tags":{"latest":"0.1.2"},"versions":{"0.1.1":{"name":"@171h/reoff-remark","type":"module","version":"0.1.1","description":"> **Note**\r > This repository is automatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.","keywords":["utils"],"sideEffects":false,"exports":{".":{"types":"./dist/index.d.ts","require":"./dist/index.cjs","import":"./dist/index.mjs"}},"main":"./dist/index.mjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","typesVersions":{"*":{"*":["./dist/*","./dist/index.d.ts"]}},"scripts":{"build":"unbuild","dev":"unbuild --stub","lint":"eslint .","prepublishOnly":"nr build","release":"npx changelogen@latest --release && npm publish --access public","start":"esno src/index.ts","test":"vitest --watch","bench":"vitest bench","test-ui":"vitest --ui","typecheck":"tsc --noEmit"},"devDependencies":{"@antfu/eslint-config":"^0.39.3","@antfu/ni":"^0.21.3","@antfu/utils":"^0.7.2","@types/luxon":"^3.3.0","@types/node":"^20.2.5","@vitest/ui":"^0.31.1","bumpp":"^9.1.0","changelogen":"^0.5.3","eslint":"^8.41.0","esno":"^0.16.3","lint-staged":"^13.2.2","rimraf":"^5.0.1","simple-git-hooks":"^2.8.1","typescript":"^5.0.4","unbuild":"^1.2.1","vite":"^4.3.9","vitest":"^0.31.1"},"dependencies":{"@types/mdast":"^4.0.0","mdast":"^3.0.0","ooxast":"^0.1.3","ooxast-util-to-mdast":"^0.1.0","unified":"^10.1.2"},"gitHead":"a79ee1efc0e5eac11a86e994a3b3f093a2fb193d","_id":"@171h/reoff-remark@0.1.1","_nodeVersion":"20.3.0","_npmVersion":"9.7.2","dist":{"integrity":"sha512-qVhXVRgVMRGUs2ptta+niI6pZ6eFVXY5ou31RranoWp7rC7YlVs3tIoS3M6Qu8/8vGvAug85ZRKDWgg4P4H4bA==","shasum":"c53732bcd8f752481d2f318bbdcef4f2ab86d30f","tarball":"https://registry.npmjs.org/@171h/reoff-remark/-/reoff-remark-0.1.1.tgz","fileCount":6,"unpackedSize":49166,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD4wgkAIo7npk0jzv91GMz9aPOUvWM7f+5MZYsmMFGTFQIgelz1MWipxMKEOX3LpQDuYzZrJcrvUxskazHFVGuXd/Y="}]},"_npmUser":{"name":"171h","email":"1091088708@qq.com"},"directories":{},"maintainers":[{"name":"171h","email":"1091088708@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/reoff-remark_0.1.1_1689688685862_0.6924618005583683"},"_hasShrinkwrap":false},"0.1.2":{"name":"@171h/reoff-remark","type":"module","version":"0.1.2","description":"> **Note**\r > This repository is automatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.","keywords":["utils"],"sideEffects":false,"exports":{".":{"types":"./dist/index.d.ts","require":"./dist/index.cjs","import":"./dist/index.mjs"}},"main":"./dist/index.mjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","typesVersions":{"*":{"*":["./dist/*","./dist/index.d.ts"]}},"scripts":{"build":"unbuild","dev":"unbuild --stub","lint":"eslint .","prepublishOnly":"nr build","release":"npx changelogen@latest --release && npm publish --access public","start":"esno src/index.ts","test":"vitest --watch","bench":"vitest bench","test-ui":"vitest --ui","typecheck":"tsc --noEmit"},"devDependencies":{"@antfu/eslint-config":"^0.39.3","@antfu/ni":"^0.21.3","@antfu/utils":"^0.7.2","@types/luxon":"^3.3.0","@types/node":"^20.2.5","@vitest/ui":"^0.31.1","bumpp":"^9.1.0","changelogen":"^0.5.3","eslint":"^8.41.0","esno":"^0.16.3","lint-staged":"^13.2.2","rimraf":"^5.0.1","simple-git-hooks":"^2.8.1","typescript":"^5.0.4","unbuild":"^1.2.1","vite":"^4.3.9","vitest":"^0.31.1"},"dependencies":{"@types/mdast":"^4.0.0","mdast":"^3.0.0","ooxast":"^0.1.3","ooxast-util-to-mdast":"^0.1.0","unified":"^10.1.2"},"gitHead":"b2b6dd8c5c331d1869f446b9816820111a07a540","_id":"@171h/reoff-remark@0.1.2","_nodeVersion":"20.3.0","_npmVersion":"9.7.2","dist":{"integrity":"sha512-m/f9/G9obPMV0yiGt1S9dQzsTzH7WPrM/cUrBvfznpdKnoMOzNnYiqFzS2+Mrv2jMAWkZEwhKx7VWVhGafC/Sg==","shasum":"10029185894798f75ac0fae3666e93a2d65028db","tarball":"https://registry.npmjs.org/@171h/reoff-remark/-/reoff-remark-0.1.2.tgz","fileCount":6,"unpackedSize":49166,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCCK9F1roT95yAs+5Y5WuuW2szL1ueew3UrOzMjaoZXTgIgBD6R7Ju1Ed9D983RhCVSyexIgRA7T+Le1Xa8z1I5FAs="}]},"_npmUser":{"name":"171h","email":"1091088708@qq.com"},"directories":{},"maintainers":[{"name":"171h","email":"1091088708@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/reoff-remark_0.1.2_1689688767506_0.8160020724339492"},"_hasShrinkwrap":false}},"time":{"created":"2023-07-18T13:58:05.785Z","0.1.1":"2023-07-18T13:58:06.082Z","modified":"2023-07-18T13:59:27.985Z","0.1.2":"2023-07-18T13:59:27.749Z"},"maintainers":[{"name":"171h","email":"1091088708@qq.com"}],"description":"> **Note**\r > This repository is automatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.","keywords":["utils"],"readme":"> **Note**\r\n> This repository is automatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.\r\n\r\n# reoff-remark\r\n\r\n[![npm version](https://badge.fury.io/js/reoff-remark.svg)](https://badge.fury.io/js/reoff-remark) [![npm downloads](https://img.shields.io/npm/dm/reoff-remark.svg)](https://www.npmjs.com/package/reoff-remark)\r\n\r\nPlugin for `reoff` that takes an `ooxast` tree and turns it into a `remark` tree, allowing for .docx to .tex conversion\r\n\r\n## Contents\r\n\r\n*   [reoff-remark](#reoff-remark)\r\n    *   [Contents](#contents)\r\n    *   [What is this?](#what-is-this)\r\n    *   [When should I use this?](#when-should-i-use-this)\r\n    *   [Install](#install)\r\n    *   [Use](#use)\r\n    *   [API](#api)\r\n    *   [Syntax tree](#syntax-tree)\r\n    *   [Types](#types)\r\n    *   [Compatibility](#compatibility)\r\n    *   [Security](#security)\r\n    *   [Related](#related)\r\n    *   [Contribute](#contribute)\r\n    *   [License](#license)\r\n\r\n## What is this?\r\n\r\n## When should I use this?\r\n\r\n## Install\r\n\r\nThis package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as\r\n\r\n```bash\r\npnpm add reoff-remark\r\n# or with yarn\r\n# yarn add reoff-remark\r\n# or with npm\r\n# npm install reoff-remark\r\n```\r\n\r\n## Use\r\n\r\n## API\r\n\r\n***\r\n\r\n### `default()`\r\n\r\nPlugin to bridge or mutate to remark\r\n\r\nIf a destination is given, runs the destination with the new mdast\r\ntree (bridge-mode).\r\nWithout destination, returns the jast tree: further plugins run on that\r\ntree (mutate-mode).\r\n\r\nThis is done so that you can use this plugin as either the plugin before the stringify plugin, or the plugin before another mutate plugin\r\n\r\n#### Signature\r\n\r\n```ts\r\ndefault(this: Processor<void, Root, void, void>, ...settings: [Processor, Options?]): void | Transformer<Root, Root>;\r\n```\r\n\r\n#### Parameters\r\n\r\n| Name | Type |\r\n| :------ | :------ |\r\n| `this` | `Processor`<`void`, `Root`, `void`, `void`> |\r\n| `...settings` | [`Processor`, `Options?`] |\r\n\r\n#### Returns\r\n\r\n`void` | `Transformer`<`Root`, `Root`>\r\n\r\nDefined in:  node\\_modules/.pnpm/unified\\@10.1.2/node\\_modules/unified/index.d.ts:531\r\n\r\nPlugin to bridge or mutate to remark\r\n\r\nIf a destination is given, runs the destination with the new mdast\r\ntree (bridge-mode).\r\nWithout destination, returns the jast tree: further plugins run on that\r\ntree (mutate-mode).\r\n\r\nThis is done so that you can use this plugin as either the plugin before the stringify plugin, or the plugin before another mutate plugin\r\n\r\n#### Signature\r\n\r\n```ts\r\ndefault(this: Processor<void, Root, void, void>, ...settings: [Options?] | void[]): void | Transformer<Root, Root>;\r\n```\r\n\r\n#### Parameters\r\n\r\n| Name | Type |\r\n| :------ | :------ |\r\n| `this` | `Processor`<`void`, `Root`, `void`, `void`> |\r\n| `...settings` | [`Options?`] | `void`[] |\r\n\r\n#### Returns\r\n\r\n`void` | `Transformer`<`Root`, `Root`>\r\n\r\nDefined in:  node\\_modules/.pnpm/unified\\@10.1.2/node\\_modules/unified/index.d.ts:531\r\n\r\n***\r\n\r\n### `Options`\r\n\r\n#### Properties\r\n\r\n##### `bibliography?`\r\n\r\n> `Data`[]\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:56](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L56)\r\n\r\n##### `bold?`\r\n\r\n> `\"**\"` | `\"__\"`\r\n\r\nShould bold be rendered with `*` or `_`?\r\n\r\n###### Default\r\n\r\n'\\*\\*'\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:46](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L46)\r\n\r\n##### `citationType?`\r\n\r\n> `\"endnote\"` | `\"native\"` | `\"mendeley\"` | `\"citavi\"` | `\"zotero\"`\r\n\r\nWhat type of citation is used?\r\n\r\n###### Default\r\n\r\n'zotero'\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:51](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L51)\r\n\r\n##### `collectCitation?`\r\n\r\n> `Function`\r\n\r\n###### Type declaration\r\n\r\n*Signature\\`*\r\n\r\n```ts\r\n(citation: any, index: string | number): any;\r\n```\r\n\r\n*Parameters\\`*\r\n\r\n| Name | Type |\r\n| :------ | :------ |\r\n| `citation` | `any` |\r\n| `index` | `string` | `number` |\r\n\r\n*Returns\\`*\r\n\r\n`any`\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:53](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L53)\r\n\r\n##### `document?`\r\n\r\n> `boolean`\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:36](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L36)\r\n\r\n##### `handlers?`\r\n\r\n> `object`\r\n\r\nHandlers for specific node types\r\n\r\n###### Index signature\r\n\r\n[`handle`: `string`]: `Handle`\r\n\r\n###### Type declaration\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:35](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L35)\r\n\r\n##### `italics?`\r\n\r\n> `\"*\"` | `\"_\"`\r\n\r\nShould italics be rendered with `*` or `_`?\r\n\r\n###### Default\r\n\r\n'\\*'\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:42](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L42)\r\n\r\n##### `newLines?`\r\n\r\n> `boolean`\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:37](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L37)\r\n\r\n##### `parseCitation?`\r\n\r\n> `Function`\r\n\r\n###### Type declaration\r\n\r\n*Signature\\`*\r\n\r\n```ts\r\n(citation: any): any;\r\n```\r\n\r\n*Parameters\\`*\r\n\r\n| Name | Type |\r\n| :------ | :------ |\r\n| `citation` | `any` |\r\n\r\n*Returns\\`*\r\n\r\n`any`\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:52](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L52)\r\n\r\n##### `quotes?`\r\n\r\n> `string`[]\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:38](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L38)\r\n\r\n##### `relations?`\r\n\r\n> `object`\r\n\r\n###### Index signature\r\n\r\n[`key`: `string`]: `string`\r\n\r\n###### Type declaration\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:54](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L54)\r\n\r\n##### `title?`\r\n\r\n> `string`\r\n\r\nDefined in:  [libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:55](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts#L55)\r\n\r\n## Syntax tree\r\n\r\n## Types\r\n\r\n## Compatibility\r\n\r\n## Security\r\n\r\n## Related\r\n\r\n## Contribute\r\n\r\n## License\r\n\r\n[GPL-3.0-or-later](LICENSE) © Thomas F. K. Jorna\r\n\r\n[unified]: https://unifiedjs.com\r\n\r\n[unifiedgh]: https://github.com/unifiedjs/unified\r\n\r\n[xast-from-xml]: https://github.com/syntax-tree/xast-util-from-xml\r\n\r\n[rehype]: https://github.com/rehypejs/rehype\r\n\r\n[rejour]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour\r\n\r\n[rejour-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-parse\r\n\r\n[rejour-stringify]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-stringify\r\n\r\n[rejour-move-abstract]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-move-abstract\r\n\r\n[rejour-meta]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-meta\r\n\r\n[rejour-relatex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-relatex\r\n\r\n[relatex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex\r\n\r\n[relatex-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/relatex-parse\r\n\r\n[jast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jast\r\n\r\n[jast-util-to-texast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jast-util-to-texast\r\n\r\n[jastscript]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jastscript\r\n\r\n[texast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/texast\r\n\r\n[texast-util-to-latex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/texast-util-to-latex\r\n\r\n[hast]: https://github.com/syntax-tree/hast\r\n\r\n[xast]: https://github.com/syntax-tree/xast\r\n\r\n[mdast]: https://github.com/syntax-tree/mdast\r\n\r\n[mdast-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown\r\n\r\n[latex-utensils]: https://github.com/tamuratak/latex-utensils\r\n\r\n[latexjs]: https://github.com/latexjs/latexjs\r\n\r\n[reoff]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff\r\n\r\n[reoff-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff/reoff-parse\r\n\r\n[reoff-rejour]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff/reoff-rejour\r\n\r\n[ooxast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/ooxast/ooxast\r\n\r\n[ooxast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/ooxast/ooxast-util-to-jast\r\n\r\n[reoff-remark]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff-remark\r\n","readmeFilename":"README.md"}