feat: Phase 1 — extract the client (web SPA + desktop) to dtoro/oikos-web
Problem: the hexagonal refactor churns the backend tree for nine more phases; the UI delivery stack (web/ SPA, cmd/desktop Wails wrapper, compose/web image) must move to its own repo first so doc/layout rewrites land once on a backend-only tree. Change: - New repo git.hubris.network/dtoro/oikos-web (v0.33.0): web/, desktop/ (updateURL repointed to oikos-web releases), compose/, own CI (web + desktop jobs), own deploy script (CI-green gate, TOCTOU guard, version-tagged images, prune-to-3), own webhook receiver on :9798 + launchd unit, own compose project publishing the same 8091:80. - Cutover executed on mac-mini in order: oikos stack's web service stopped+removed, oikos-web project brought up on 8091; outer Caddy untouched (targets the published port) — serving + Authentik flow + /wails 404 quirk verified post-cutover. - Stripped from oikos: web/, cmd/desktop/, compose/web/, desktop CI workflow, ci.yml web job, Makefile ui/desktop/desktop-package/install targets, the compose web service, oikos-web from deploy.sh's fallback prune list; wails + go-keyring dropped from go.mod, vendor synced. - README / CONTRIBUTING / AGENTS.md / .agents dev+operations docs now point at the new repo; mbse + mascot design docs carry a path note. Risk: production SPA serving depends on the new pipeline now; rollback is versioned-image re-up of the old web service from a pre-split checkout (port 8091). Desktop builds installed before the split still check dtoro/oikos releases — one manual reinstall, noted in the oikos-web release notes. Verification: go vet, make test (race), make generate-check, golangci (no new findings; baseline down 400→365); post-cutover curls — localhost:8091 200, /wails/runtime.js 404, outer Caddy 302 Authentik.
This commit is contained in:
44
web/node_modules/marked/LICENSE
generated
vendored
Normal file
44
web/node_modules/marked/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
# License information
|
||||
|
||||
## Contribution License Agreement
|
||||
|
||||
If you contribute code to this project, you are implicitly allowing your code
|
||||
to be distributed under the MIT license. You are also implicitly verifying that
|
||||
all code is your original work. `</legalese>`
|
||||
|
||||
## Marked
|
||||
|
||||
Copyright (c) 2018+, MarkedJS (https://github.com/markedjs/)
|
||||
Copyright (c) 2011-2018, Christopher Jeffrey (https://github.com/chjj/)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
## Markdown
|
||||
|
||||
Copyright © 2004, John Gruber
|
||||
http://daringfireball.net/
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
* Neither the name “Markdown” nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
This software is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.
|
||||
115
web/node_modules/marked/README.md
generated
vendored
Normal file
115
web/node_modules/marked/README.md
generated
vendored
Normal file
@@ -0,0 +1,115 @@
|
||||
<a href="https://marked.js.org">
|
||||
<img width="60px" height="60px" src="https://marked.js.org/img/logo-black.svg" align="right" />
|
||||
</a>
|
||||
|
||||
# Marked
|
||||
|
||||
[](https://www.npmjs.com/package/marked)
|
||||
[](https://packagephobia.now.sh/result?p=marked)
|
||||
[](https://www.npmjs.com/package/marked)
|
||||
[](https://github.com/markedjs/marked/actions)
|
||||
[](https://snyk.io/test/npm/marked)
|
||||
|
||||
- ⚡ built for speed
|
||||
- ⬇️ low-level compiler for parsing markdown without caching or blocking for long periods of time
|
||||
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications
|
||||
- 🌐 works in a browser, on a server, or from a command line interface (CLI)
|
||||
|
||||
## Demo
|
||||
|
||||
Check out the [demo page](https://marked.js.org/demo/) to see Marked in action ⛹️
|
||||
|
||||
## Docs
|
||||
|
||||
Our [documentation pages](https://marked.js.org) are also rendered using marked 💯
|
||||
|
||||
Also read about:
|
||||
|
||||
* [Options](https://marked.js.org/using_advanced)
|
||||
* [Extensibility](https://marked.js.org/using_pro)
|
||||
|
||||
## Compatibility
|
||||
|
||||
**Node.js:** Only [current and LTS](https://nodejs.org/en/about/releases/) Node.js versions are supported. End of life Node.js versions may become incompatible with Marked at any point in time.
|
||||
|
||||
**Browser:** [Baseline Widely Available](https://developer.mozilla.org/en-US/docs/Glossary/Baseline/Compatibility)
|
||||
|
||||
## Installation
|
||||
|
||||
**CLI:**
|
||||
|
||||
```sh
|
||||
npm install -g marked
|
||||
```
|
||||
|
||||
**In-browser:**
|
||||
|
||||
```sh
|
||||
npm install marked
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/using_advanced#options) the output HTML. Please use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the *output* HTML! 🚨
|
||||
|
||||
```
|
||||
DOMPurify.sanitize(marked.parse(`<img src="x" onerror="alert('not happening')">`));
|
||||
```
|
||||
|
||||
**CLI**
|
||||
|
||||
``` bash
|
||||
# Example with stdin input
|
||||
$ marked -o hello.html
|
||||
hello world
|
||||
^D
|
||||
$ cat hello.html
|
||||
<p>hello world</p>
|
||||
```
|
||||
|
||||
```bash
|
||||
# Print all options
|
||||
$ marked --help
|
||||
```
|
||||
|
||||
**Node.js**
|
||||
|
||||
```js
|
||||
import { marked } from 'marked';
|
||||
const html = marked.parse('# Marked in Node.js');
|
||||
console.log(html);
|
||||
```
|
||||
|
||||
**Browser**
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<title>Marked in the browser</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="content"></div>
|
||||
<script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
|
||||
<script>
|
||||
document.getElementById('content').innerHTML =
|
||||
marked.parse('# Marked in the browser\n\nRendered by **marked**.');
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
or import esm module
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import { marked } from "https://cdn.jsdelivr.net/npm/marked/lib/marked.esm.js";
|
||||
document.getElementById('content').innerHTML =
|
||||
marked.parse('# Marked in the browser\n\nRendered by **marked**.');
|
||||
</script>
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2018+, MarkedJS. (MIT License)
|
||||
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
|
||||
284
web/node_modules/marked/bin/main.js
generated
vendored
Normal file
284
web/node_modules/marked/bin/main.js
generated
vendored
Normal file
@@ -0,0 +1,284 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Marked CLI
|
||||
* Copyright (c) 2018+, MarkedJS. (MIT License)
|
||||
* Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
|
||||
*/
|
||||
|
||||
import { promises } from 'node:fs';
|
||||
import { dirname, resolve } from 'node:path';
|
||||
import { homedir } from 'node:os';
|
||||
import { createRequire } from 'node:module';
|
||||
import { pathToFileURL } from 'node:url';
|
||||
import { marked } from '../lib/marked.esm.js';
|
||||
|
||||
const { access, readFile, writeFile } = promises;
|
||||
const require = createRequire(import.meta.url);
|
||||
|
||||
/**
|
||||
* @param {Process} nodeProcess inject process so it can be mocked in tests.
|
||||
*/
|
||||
export async function main(nodeProcess) {
|
||||
/**
|
||||
* Man Page
|
||||
*/
|
||||
async function help() {
|
||||
const { spawn } = await import('child_process');
|
||||
const { fileURLToPath } = await import('url');
|
||||
|
||||
const options = {
|
||||
cwd: nodeProcess.cwd(),
|
||||
env: nodeProcess.env,
|
||||
stdio: 'inherit',
|
||||
};
|
||||
|
||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
const helpText = await readFile(resolve(__dirname, '../man/marked.1.md'), 'utf8');
|
||||
|
||||
await new Promise(res => {
|
||||
const manProcess = spawn('man', [resolve(__dirname, '../man/marked.1')], options);
|
||||
nodeProcess.on('SIGINT', () => {
|
||||
manProcess.kill('SIGINT');
|
||||
});
|
||||
|
||||
manProcess.on('error', () => {
|
||||
console.log(helpText);
|
||||
})
|
||||
.on('close', res);
|
||||
});
|
||||
}
|
||||
|
||||
async function version() {
|
||||
const pkg = require('../package.json');
|
||||
console.log(pkg.version);
|
||||
}
|
||||
|
||||
/**
|
||||
* Main
|
||||
*/
|
||||
async function start(argv) {
|
||||
const files = [];
|
||||
const options = {};
|
||||
let input;
|
||||
let output;
|
||||
let string;
|
||||
let arg;
|
||||
let tokens;
|
||||
let config;
|
||||
let opt;
|
||||
let noclobber;
|
||||
|
||||
function getArg() {
|
||||
let arg = argv.shift();
|
||||
|
||||
if (arg.indexOf('--') === 0) {
|
||||
// e.g. --opt
|
||||
arg = arg.split('=');
|
||||
if (arg.length > 1) {
|
||||
// e.g. --opt=val
|
||||
argv.unshift(arg.slice(1).join('='));
|
||||
}
|
||||
arg = arg[0];
|
||||
} else if (arg[0] === '-') {
|
||||
if (arg.length > 2) {
|
||||
// e.g. -abc
|
||||
argv = arg.substring(1).split('').map(function(ch) {
|
||||
return '-' + ch;
|
||||
}).concat(argv);
|
||||
arg = argv.shift();
|
||||
} else {
|
||||
// e.g. -a
|
||||
}
|
||||
} else {
|
||||
// e.g. foo
|
||||
}
|
||||
|
||||
return arg;
|
||||
}
|
||||
|
||||
while (argv.length) {
|
||||
arg = getArg();
|
||||
switch (arg) {
|
||||
case '-o':
|
||||
case '--output':
|
||||
output = argv.shift();
|
||||
break;
|
||||
case '-i':
|
||||
case '--input':
|
||||
input = argv.shift();
|
||||
break;
|
||||
case '-s':
|
||||
case '--string':
|
||||
string = argv.shift();
|
||||
break;
|
||||
case '-t':
|
||||
case '--tokens':
|
||||
tokens = true;
|
||||
break;
|
||||
case '-c':
|
||||
case '--config':
|
||||
config = argv.shift();
|
||||
break;
|
||||
case '-n':
|
||||
case '--no-clobber':
|
||||
noclobber = true;
|
||||
break;
|
||||
case '-h':
|
||||
case '--help':
|
||||
return await help();
|
||||
case '-v':
|
||||
case '--version':
|
||||
return await version();
|
||||
default:
|
||||
if (arg.indexOf('--') === 0) {
|
||||
opt = camelize(arg.replace(/^--(no-)?/, ''));
|
||||
if (!(opt in marked.defaults)) {
|
||||
continue;
|
||||
}
|
||||
if (arg.indexOf('--no-') === 0) {
|
||||
options[opt] = typeof marked.defaults[opt] !== 'boolean'
|
||||
? null
|
||||
: false;
|
||||
} else {
|
||||
options[opt] = typeof marked.defaults[opt] !== 'boolean'
|
||||
? argv.shift()
|
||||
: true;
|
||||
}
|
||||
} else {
|
||||
files.push(arg);
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
async function getData() {
|
||||
if (string) {
|
||||
return string;
|
||||
}
|
||||
if (input) {
|
||||
return await readFile(input, 'utf8');
|
||||
}
|
||||
if (files.length > 0) {
|
||||
return await readFile(files.pop(), 'utf8');
|
||||
}
|
||||
return await getStdin();
|
||||
}
|
||||
|
||||
function resolveFile(file) {
|
||||
return resolve(file.replace(/^~/, homedir));
|
||||
}
|
||||
|
||||
function fileExists(file) {
|
||||
return access(resolveFile(file)).then(() => true, () => false);
|
||||
}
|
||||
|
||||
async function runConfig(file) {
|
||||
const configFile = resolveFile(file);
|
||||
let markedConfig;
|
||||
try {
|
||||
// try require for json
|
||||
markedConfig = require(configFile);
|
||||
} catch(err) {
|
||||
if (err.code !== 'ERR_REQUIRE_ESM') {
|
||||
throw err;
|
||||
}
|
||||
// must import esm
|
||||
markedConfig = await import(pathToFileURL(configFile).href);
|
||||
}
|
||||
|
||||
if (markedConfig.default) {
|
||||
markedConfig = markedConfig.default;
|
||||
}
|
||||
|
||||
if (typeof markedConfig === 'function') {
|
||||
markedConfig(marked);
|
||||
} else {
|
||||
marked.use(markedConfig);
|
||||
}
|
||||
}
|
||||
|
||||
const data = await getData();
|
||||
|
||||
if (config) {
|
||||
if (!await fileExists(config)) {
|
||||
throw Error(`Cannot load config file '${config}'`);
|
||||
}
|
||||
|
||||
await runConfig(config);
|
||||
} else {
|
||||
const defaultConfig = [
|
||||
'~/.marked.json',
|
||||
'~/.marked.js',
|
||||
'~/.marked/index.js',
|
||||
];
|
||||
|
||||
for (const configFile of defaultConfig) {
|
||||
if (await fileExists(configFile)) {
|
||||
await runConfig(configFile);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const html = tokens
|
||||
? JSON.stringify(marked.lexer(data, options), null, 2)
|
||||
: await marked.parse(data, options);
|
||||
|
||||
if (output) {
|
||||
if (noclobber && await fileExists(output)) {
|
||||
throw Error('marked: output file \'' + output + '\' already exists, disable the \'-n\' / \'--no-clobber\' flag to overwrite\n');
|
||||
}
|
||||
return await writeFile(output, html);
|
||||
}
|
||||
|
||||
nodeProcess.stdout.write(html + '\n');
|
||||
}
|
||||
|
||||
/**
|
||||
* Helpers
|
||||
*/
|
||||
function getStdin() {
|
||||
return new Promise((resolve, reject) => {
|
||||
const stdin = nodeProcess.stdin;
|
||||
let buff = '';
|
||||
|
||||
stdin.setEncoding('utf8');
|
||||
|
||||
stdin.on('data', function(data) {
|
||||
buff += data;
|
||||
});
|
||||
|
||||
stdin.on('error', function(err) {
|
||||
reject(err);
|
||||
});
|
||||
|
||||
stdin.on('end', function() {
|
||||
resolve(buff);
|
||||
});
|
||||
|
||||
stdin.resume();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} text
|
||||
*/
|
||||
function camelize(text) {
|
||||
return text.replace(/(\w)-(\w)/g, function(_, a, b) {
|
||||
return a + b.toUpperCase();
|
||||
});
|
||||
}
|
||||
|
||||
try {
|
||||
await start(nodeProcess.argv.slice(2));
|
||||
nodeProcess.exit(0);
|
||||
} catch(err) {
|
||||
if (err.code === 'ENOENT') {
|
||||
nodeProcess.stderr.write('marked: ' + err.path + ': No such file or directory');
|
||||
} else {
|
||||
nodeProcess.stderr.write(err.message);
|
||||
}
|
||||
return nodeProcess.exit(1);
|
||||
}
|
||||
}
|
||||
16
web/node_modules/marked/bin/marked.js
generated
vendored
Executable file
16
web/node_modules/marked/bin/marked.js
generated
vendored
Executable file
@@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Marked CLI
|
||||
* Copyright (c) 2018+, MarkedJS. (MIT License)
|
||||
* Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
|
||||
*/
|
||||
|
||||
import { main } from './main.js';
|
||||
|
||||
/**
|
||||
* Expose / Entry Point
|
||||
*/
|
||||
|
||||
process.title = 'marked';
|
||||
main(process);
|
||||
816
web/node_modules/marked/lib/marked.d.ts
generated
vendored
Normal file
816
web/node_modules/marked/lib/marked.d.ts
generated
vendored
Normal file
@@ -0,0 +1,816 @@
|
||||
// Generated by dts-bundle-generator v9.5.1
|
||||
|
||||
export type MarkedToken = (Tokens.Blockquote | Tokens.Br | Tokens.Checkbox | Tokens.Code | Tokens.Codespan | Tokens.Def | Tokens.Del | Tokens.Em | Tokens.Escape | Tokens.Heading | Tokens.Hr | Tokens.HTML | Tokens.Image | Tokens.Link | Tokens.List | Tokens.ListItem | Tokens.Paragraph | Tokens.Space | Tokens.Strong | Tokens.Table | Tokens.Tag | Tokens.Text);
|
||||
export type Token = (MarkedToken | Tokens.Generic);
|
||||
export declare namespace Tokens {
|
||||
interface Blockquote {
|
||||
type: "blockquote";
|
||||
raw: string;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Br {
|
||||
type: "br";
|
||||
raw: string;
|
||||
}
|
||||
interface Checkbox {
|
||||
type: "checkbox";
|
||||
raw: string;
|
||||
checked: boolean;
|
||||
}
|
||||
interface Code {
|
||||
type: "code";
|
||||
raw: string;
|
||||
codeBlockStyle?: "indented";
|
||||
lang?: string;
|
||||
text: string;
|
||||
escaped?: boolean;
|
||||
}
|
||||
interface Codespan {
|
||||
type: "codespan";
|
||||
raw: string;
|
||||
text: string;
|
||||
}
|
||||
interface Def {
|
||||
type: "def";
|
||||
raw: string;
|
||||
tag: string;
|
||||
href: string;
|
||||
title: string;
|
||||
}
|
||||
interface Del {
|
||||
type: "del";
|
||||
raw: string;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Em {
|
||||
type: "em";
|
||||
raw: string;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Escape {
|
||||
type: "escape";
|
||||
raw: string;
|
||||
text: string;
|
||||
}
|
||||
interface Generic {
|
||||
[index: string]: any;
|
||||
type: string;
|
||||
raw: string;
|
||||
tokens?: Token[];
|
||||
}
|
||||
interface Heading {
|
||||
type: "heading";
|
||||
raw: string;
|
||||
depth: number;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Hr {
|
||||
type: "hr";
|
||||
raw: string;
|
||||
}
|
||||
interface HTML {
|
||||
type: "html";
|
||||
raw: string;
|
||||
pre: boolean;
|
||||
text: string;
|
||||
block: boolean;
|
||||
}
|
||||
interface Image {
|
||||
type: "image";
|
||||
raw: string;
|
||||
href: string;
|
||||
title: string | null;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Link {
|
||||
type: "link";
|
||||
raw: string;
|
||||
href: string;
|
||||
title?: string | null;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface List {
|
||||
type: "list";
|
||||
raw: string;
|
||||
ordered: boolean;
|
||||
start: number | "";
|
||||
loose: boolean;
|
||||
items: ListItem[];
|
||||
}
|
||||
interface ListItem {
|
||||
type: "list_item";
|
||||
raw: string;
|
||||
task: boolean;
|
||||
checked?: boolean;
|
||||
loose: boolean;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Paragraph {
|
||||
type: "paragraph";
|
||||
raw: string;
|
||||
pre?: boolean;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Space {
|
||||
type: "space";
|
||||
raw: string;
|
||||
}
|
||||
interface Strong {
|
||||
type: "strong";
|
||||
raw: string;
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
}
|
||||
interface Table {
|
||||
type: "table";
|
||||
raw: string;
|
||||
align: Array<"center" | "left" | "right" | null>;
|
||||
header: TableCell[];
|
||||
rows: TableCell[][];
|
||||
}
|
||||
interface TableCell {
|
||||
text: string;
|
||||
tokens: Token[];
|
||||
header: boolean;
|
||||
align: "center" | "left" | "right" | null;
|
||||
}
|
||||
interface TableRow<P = string> {
|
||||
text: P;
|
||||
}
|
||||
interface Tag {
|
||||
type: "html";
|
||||
raw: string;
|
||||
inLink: boolean;
|
||||
inRawBlock: boolean;
|
||||
text: string;
|
||||
block: boolean;
|
||||
}
|
||||
interface Text {
|
||||
type: "text";
|
||||
raw: string;
|
||||
text: string;
|
||||
tokens?: Token[];
|
||||
escaped?: boolean;
|
||||
}
|
||||
}
|
||||
export type Links = Record<string, Pick<Tokens.Link | Tokens.Image, "href" | "title">>;
|
||||
export type TokensList = Token[] & {
|
||||
links: Links;
|
||||
};
|
||||
/**
|
||||
* Renderer
|
||||
*/
|
||||
declare class _Renderer<ParserOutput = string, RendererOutput = string> {
|
||||
options: MarkedOptions<ParserOutput, RendererOutput>;
|
||||
parser: _Parser<ParserOutput, RendererOutput>;
|
||||
constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
|
||||
space(token: Tokens.Space): RendererOutput;
|
||||
code({ text, lang, escaped }: Tokens.Code): RendererOutput;
|
||||
blockquote({ tokens }: Tokens.Blockquote): RendererOutput;
|
||||
html({ text }: Tokens.HTML | Tokens.Tag): RendererOutput;
|
||||
def(token: Tokens.Def): RendererOutput;
|
||||
heading({ tokens, depth }: Tokens.Heading): RendererOutput;
|
||||
hr(token: Tokens.Hr): RendererOutput;
|
||||
list(token: Tokens.List): RendererOutput;
|
||||
listitem(item: Tokens.ListItem): RendererOutput;
|
||||
checkbox({ checked }: Tokens.Checkbox): RendererOutput;
|
||||
paragraph({ tokens }: Tokens.Paragraph): RendererOutput;
|
||||
table(token: Tokens.Table): RendererOutput;
|
||||
tablerow({ text }: Tokens.TableRow<ParserOutput>): RendererOutput;
|
||||
tablecell(token: Tokens.TableCell): RendererOutput;
|
||||
/**
|
||||
* span level renderer
|
||||
*/
|
||||
strong({ tokens }: Tokens.Strong): RendererOutput;
|
||||
em({ tokens }: Tokens.Em): RendererOutput;
|
||||
codespan({ text }: Tokens.Codespan): RendererOutput;
|
||||
br(token: Tokens.Br): RendererOutput;
|
||||
del({ tokens }: Tokens.Del): RendererOutput;
|
||||
link({ href, title, tokens }: Tokens.Link): RendererOutput;
|
||||
image({ href, title, text, tokens }: Tokens.Image): RendererOutput;
|
||||
text(token: Tokens.Text | Tokens.Escape): RendererOutput;
|
||||
}
|
||||
/**
|
||||
* TextRenderer
|
||||
* returns only the textual part of the token
|
||||
*/
|
||||
declare class _TextRenderer<RendererOutput = string> {
|
||||
strong({ text }: Tokens.Strong): RendererOutput;
|
||||
em({ text }: Tokens.Em): RendererOutput;
|
||||
codespan({ text }: Tokens.Codespan): RendererOutput;
|
||||
del({ text }: Tokens.Del): RendererOutput;
|
||||
html({ text }: Tokens.HTML | Tokens.Tag): RendererOutput;
|
||||
text({ text }: Tokens.Text | Tokens.Escape | Tokens.Tag): RendererOutput;
|
||||
link({ text }: Tokens.Link): RendererOutput;
|
||||
image({ text }: Tokens.Image): RendererOutput;
|
||||
br(): RendererOutput;
|
||||
checkbox({ raw }: Tokens.Checkbox): RendererOutput;
|
||||
}
|
||||
/**
|
||||
* Parsing & Compiling
|
||||
*/
|
||||
declare class _Parser<ParserOutput = string, RendererOutput = string> {
|
||||
options: MarkedOptions<ParserOutput, RendererOutput>;
|
||||
renderer: _Renderer<ParserOutput, RendererOutput>;
|
||||
textRenderer: _TextRenderer<RendererOutput>;
|
||||
constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
|
||||
/**
|
||||
* Static Parse Method
|
||||
*/
|
||||
static parse<ParserOutput = string, RendererOutput = string>(tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput>): ParserOutput;
|
||||
/**
|
||||
* Static Parse Inline Method
|
||||
*/
|
||||
static parseInline<ParserOutput = string, RendererOutput = string>(tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput>): ParserOutput;
|
||||
/**
|
||||
* Parse Loop
|
||||
*/
|
||||
parse(tokens: Token[]): ParserOutput;
|
||||
/**
|
||||
* Parse Inline Tokens
|
||||
*/
|
||||
parseInline(tokens: Token[], renderer?: _Renderer<ParserOutput, RendererOutput> | _TextRenderer<RendererOutput>): ParserOutput;
|
||||
}
|
||||
declare const other: {
|
||||
codeRemoveIndent: RegExp;
|
||||
outputLinkReplace: RegExp;
|
||||
indentCodeCompensation: RegExp;
|
||||
beginningSpace: RegExp;
|
||||
endingHash: RegExp;
|
||||
startingSpaceChar: RegExp;
|
||||
endingSpaceChar: RegExp;
|
||||
nonSpaceChar: RegExp;
|
||||
newLineCharGlobal: RegExp;
|
||||
tabCharGlobal: RegExp;
|
||||
multipleSpaceGlobal: RegExp;
|
||||
blankLine: RegExp;
|
||||
doubleBlankLine: RegExp;
|
||||
blockquoteStart: RegExp;
|
||||
blockquoteSetextReplace: RegExp;
|
||||
blockquoteSetextReplace2: RegExp;
|
||||
listReplaceNesting: RegExp;
|
||||
listIsTask: RegExp;
|
||||
listReplaceTask: RegExp;
|
||||
listTaskCheckbox: RegExp;
|
||||
anyLine: RegExp;
|
||||
hrefBrackets: RegExp;
|
||||
tableDelimiter: RegExp;
|
||||
tableAlignChars: RegExp;
|
||||
tableRowBlankLine: RegExp;
|
||||
tableAlignRight: RegExp;
|
||||
tableAlignCenter: RegExp;
|
||||
tableAlignLeft: RegExp;
|
||||
startATag: RegExp;
|
||||
endATag: RegExp;
|
||||
startPreScriptTag: RegExp;
|
||||
endPreScriptTag: RegExp;
|
||||
startAngleBracket: RegExp;
|
||||
endAngleBracket: RegExp;
|
||||
pedanticHrefTitle: RegExp;
|
||||
unicodeAlphaNumeric: RegExp;
|
||||
escapeTest: RegExp;
|
||||
escapeReplace: RegExp;
|
||||
escapeTestNoEncode: RegExp;
|
||||
escapeReplaceNoEncode: RegExp;
|
||||
caret: RegExp;
|
||||
percentDecode: RegExp;
|
||||
findPipe: RegExp;
|
||||
splitPipe: RegExp;
|
||||
slashPipe: RegExp;
|
||||
carriageReturn: RegExp;
|
||||
spaceLine: RegExp;
|
||||
notSpaceStart: RegExp;
|
||||
endingNewline: RegExp;
|
||||
listItemRegex: (bull: string) => RegExp;
|
||||
nextBulletRegex: (indent: number) => RegExp;
|
||||
hrRegex: (indent: number) => RegExp;
|
||||
fencesBeginRegex: (indent: number) => RegExp;
|
||||
headingBeginRegex: (indent: number) => RegExp;
|
||||
htmlBeginRegex: (indent: number) => RegExp;
|
||||
blockquoteBeginRegex: (indent: number) => RegExp;
|
||||
};
|
||||
declare const blockNormal: {
|
||||
blockquote: RegExp;
|
||||
code: RegExp;
|
||||
def: RegExp;
|
||||
fences: RegExp;
|
||||
heading: RegExp;
|
||||
hr: RegExp;
|
||||
html: RegExp;
|
||||
lheading: RegExp;
|
||||
list: RegExp;
|
||||
newline: RegExp;
|
||||
paragraph: RegExp;
|
||||
table: RegExp;
|
||||
text: RegExp;
|
||||
};
|
||||
export type BlockKeys = keyof typeof blockNormal;
|
||||
declare const inlineNormal: {
|
||||
_backpedal: RegExp;
|
||||
anyPunctuation: RegExp;
|
||||
autolink: RegExp;
|
||||
blockSkip: RegExp;
|
||||
br: RegExp;
|
||||
code: RegExp;
|
||||
del: RegExp;
|
||||
delLDelim: RegExp;
|
||||
delRDelim: RegExp;
|
||||
emStrongLDelim: RegExp;
|
||||
emStrongRDelimAst: RegExp;
|
||||
emStrongRDelimUnd: RegExp;
|
||||
escape: RegExp;
|
||||
link: RegExp;
|
||||
nolink: RegExp;
|
||||
punctuation: RegExp;
|
||||
reflink: RegExp;
|
||||
reflinkSearch: RegExp;
|
||||
tag: RegExp;
|
||||
text: RegExp;
|
||||
url: RegExp;
|
||||
};
|
||||
export type InlineKeys = keyof typeof inlineNormal;
|
||||
export interface Rules {
|
||||
other: typeof other;
|
||||
block: Record<BlockKeys, RegExp>;
|
||||
inline: Record<InlineKeys, RegExp>;
|
||||
}
|
||||
/**
|
||||
* Tokenizer
|
||||
*/
|
||||
declare class _Tokenizer<ParserOutput = string, RendererOutput = string> {
|
||||
options: MarkedOptions<ParserOutput, RendererOutput>;
|
||||
rules: Rules;
|
||||
lexer: _Lexer<ParserOutput, RendererOutput>;
|
||||
constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
|
||||
space(src: string): Tokens.Space | undefined;
|
||||
code(src: string): Tokens.Code | undefined;
|
||||
fences(src: string): Tokens.Code | undefined;
|
||||
heading(src: string): Tokens.Heading | undefined;
|
||||
hr(src: string): Tokens.Hr | undefined;
|
||||
blockquote(src: string): Tokens.Blockquote | undefined;
|
||||
list(src: string): Tokens.List | undefined;
|
||||
html(src: string): Tokens.HTML | undefined;
|
||||
def(src: string): Tokens.Def | undefined;
|
||||
table(src: string): Tokens.Table | undefined;
|
||||
lheading(src: string): Tokens.Heading | undefined;
|
||||
paragraph(src: string): Tokens.Paragraph | undefined;
|
||||
text(src: string): Tokens.Text | undefined;
|
||||
escape(src: string): Tokens.Escape | undefined;
|
||||
tag(src: string): Tokens.Tag | undefined;
|
||||
link(src: string): Tokens.Link | Tokens.Image | undefined;
|
||||
reflink(src: string, links: Links): Tokens.Link | Tokens.Image | Tokens.Text | undefined;
|
||||
emStrong(src: string, maskedSrc: string, prevChar?: string): Tokens.Em | Tokens.Strong | undefined;
|
||||
codespan(src: string): Tokens.Codespan | undefined;
|
||||
br(src: string): Tokens.Br | undefined;
|
||||
del(src: string, maskedSrc: string, prevChar?: string): Tokens.Del | undefined;
|
||||
autolink(src: string): Tokens.Link | undefined;
|
||||
url(src: string): Tokens.Link | undefined;
|
||||
inlineText(src: string): Tokens.Text | undefined;
|
||||
}
|
||||
declare class _Hooks<ParserOutput = string, RendererOutput = string> {
|
||||
options: MarkedOptions<ParserOutput, RendererOutput>;
|
||||
block?: boolean;
|
||||
constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
|
||||
static passThroughHooks: Set<string>;
|
||||
static passThroughHooksRespectAsync: Set<string>;
|
||||
/**
|
||||
* Process markdown before marked
|
||||
*/
|
||||
preprocess(markdown: string): string;
|
||||
/**
|
||||
* Process HTML after marked is finished
|
||||
*/
|
||||
postprocess(html: ParserOutput): ParserOutput;
|
||||
/**
|
||||
* Process all tokens before walk tokens
|
||||
*/
|
||||
processAllTokens(tokens: Token[] | TokensList): Token[] | TokensList;
|
||||
/**
|
||||
* Mask contents that should not be interpreted as em/strong delimiters
|
||||
*/
|
||||
emStrongMask(src: string): string;
|
||||
/**
|
||||
* Provide function to tokenize markdown
|
||||
*/
|
||||
provideLexer(block?: boolean | undefined): typeof _Lexer.lexInline;
|
||||
/**
|
||||
* Provide function to parse tokens
|
||||
*/
|
||||
provideParser(block?: boolean | undefined): (tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput> | undefined) => ParserOutput;
|
||||
}
|
||||
export interface TokenizerThis {
|
||||
lexer: _Lexer;
|
||||
}
|
||||
export type TokenizerExtensionFunction = (this: TokenizerThis, src: string, tokens: Token[] | TokensList) => Tokens.Generic | undefined;
|
||||
export type TokenizerStartFunction = (this: TokenizerThis, src: string) => number | void;
|
||||
export interface TokenizerExtension {
|
||||
name: string;
|
||||
level: "block" | "inline";
|
||||
start?: TokenizerStartFunction;
|
||||
tokenizer: TokenizerExtensionFunction;
|
||||
childTokens?: string[];
|
||||
}
|
||||
export interface RendererThis<ParserOutput = string, RendererOutput = string> {
|
||||
parser: _Parser<ParserOutput, RendererOutput>;
|
||||
}
|
||||
export type RendererExtensionFunction<ParserOutput = string, RendererOutput = string> = (this: RendererThis<ParserOutput, RendererOutput>, token: Tokens.Generic) => RendererOutput | false | undefined;
|
||||
export interface RendererExtension<ParserOutput = string, RendererOutput = string> {
|
||||
name: string;
|
||||
renderer: RendererExtensionFunction<ParserOutput, RendererOutput>;
|
||||
}
|
||||
export type TokenizerAndRendererExtension<ParserOutput = string, RendererOutput = string> = TokenizerExtension | RendererExtension<ParserOutput, RendererOutput> | (TokenizerExtension & RendererExtension<ParserOutput, RendererOutput>);
|
||||
export type HooksApi<ParserOutput = string, RendererOutput = string> = Omit<_Hooks<ParserOutput, RendererOutput>, "constructor" | "options" | "block">;
|
||||
export type HooksObject<ParserOutput = string, RendererOutput = string> = {
|
||||
[K in keyof HooksApi<ParserOutput, RendererOutput>]?: (this: _Hooks<ParserOutput, RendererOutput>, ...args: Parameters<HooksApi<ParserOutput, RendererOutput>[K]>) => ReturnType<HooksApi<ParserOutput, RendererOutput>[K]> | Promise<ReturnType<HooksApi<ParserOutput, RendererOutput>[K]>>;
|
||||
};
|
||||
export type RendererApi<ParserOutput = string, RendererOutput = string> = Omit<_Renderer<ParserOutput, RendererOutput>, "constructor" | "options" | "parser">;
|
||||
export type RendererObject<ParserOutput = string, RendererOutput = string> = {
|
||||
[K in keyof RendererApi<ParserOutput, RendererOutput>]?: (this: _Renderer<ParserOutput, RendererOutput>, ...args: Parameters<RendererApi<ParserOutput, RendererOutput>[K]>) => ReturnType<RendererApi<ParserOutput, RendererOutput>[K]> | false;
|
||||
};
|
||||
export type TokenizerApi<ParserOutput = string, RendererOutput = string> = Omit<_Tokenizer<ParserOutput, RendererOutput>, "constructor" | "options" | "rules" | "lexer">;
|
||||
export type TokenizerObject<ParserOutput = string, RendererOutput = string> = {
|
||||
[K in keyof TokenizerApi<ParserOutput, RendererOutput>]?: (this: _Tokenizer<ParserOutput, RendererOutput>, ...args: Parameters<TokenizerApi<ParserOutput, RendererOutput>[K]>) => ReturnType<TokenizerApi<ParserOutput, RendererOutput>[K]> | false;
|
||||
};
|
||||
export interface MarkedExtension<ParserOutput = string, RendererOutput = string> {
|
||||
/**
|
||||
* True will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.
|
||||
*/
|
||||
async?: boolean;
|
||||
/**
|
||||
* Enable GFM line breaks. This option requires the gfm option to be true.
|
||||
*/
|
||||
breaks?: boolean;
|
||||
/**
|
||||
* Add tokenizers and renderers to marked
|
||||
*/
|
||||
extensions?: TokenizerAndRendererExtension<ParserOutput, RendererOutput>[] | null;
|
||||
/**
|
||||
* Enable GitHub flavored markdown.
|
||||
*/
|
||||
gfm?: boolean;
|
||||
/**
|
||||
* Hooks are methods that hook into some part of marked.
|
||||
* preprocess is called to process markdown before sending it to marked.
|
||||
* processAllTokens is called with the TokensList before walkTokens.
|
||||
* postprocess is called to process html after marked has finished parsing.
|
||||
* emStrongMask is called to mask contents that should not be interpreted as em/strong delimiters.
|
||||
* provideLexer is called to provide a function to tokenize markdown.
|
||||
* provideParser is called to provide a function to parse tokens.
|
||||
*/
|
||||
hooks?: HooksObject<ParserOutput, RendererOutput> | null;
|
||||
/**
|
||||
* Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
|
||||
*/
|
||||
pedantic?: boolean;
|
||||
/**
|
||||
* Type: object Default: new Renderer()
|
||||
*
|
||||
* An object containing functions to render tokens to HTML.
|
||||
*/
|
||||
renderer?: RendererObject<ParserOutput, RendererOutput> | null;
|
||||
/**
|
||||
* Shows an HTML error message when rendering fails.
|
||||
*/
|
||||
silent?: boolean;
|
||||
/**
|
||||
* The tokenizer defines how to turn markdown text into tokens.
|
||||
*/
|
||||
tokenizer?: TokenizerObject | null;
|
||||
/**
|
||||
* The walkTokens function gets called with every token.
|
||||
* Child tokens are called before moving on to sibling tokens.
|
||||
* Each token is passed by reference so updates are persisted when passed to the parser.
|
||||
* The return value of the function is ignored.
|
||||
*/
|
||||
walkTokens?: ((token: Token) => void | Promise<void>) | null;
|
||||
}
|
||||
export interface MarkedOptions<ParserOutput = string, RendererOutput = string> extends Omit<MarkedExtension<ParserOutput, RendererOutput>, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
|
||||
/**
|
||||
* Hooks are methods that hook into some part of marked.
|
||||
*/
|
||||
hooks?: _Hooks<ParserOutput, RendererOutput> | null;
|
||||
/**
|
||||
* Type: object Default: new Renderer()
|
||||
*
|
||||
* An object containing functions to render tokens to HTML.
|
||||
*/
|
||||
renderer?: _Renderer<ParserOutput, RendererOutput> | null;
|
||||
/**
|
||||
* The tokenizer defines how to turn markdown text into tokens.
|
||||
*/
|
||||
tokenizer?: _Tokenizer<ParserOutput, RendererOutput> | null;
|
||||
/**
|
||||
* Custom extensions
|
||||
*/
|
||||
extensions?: null | {
|
||||
renderers: {
|
||||
[name: string]: RendererExtensionFunction<ParserOutput, RendererOutput>;
|
||||
};
|
||||
childTokens: {
|
||||
[name: string]: string[];
|
||||
};
|
||||
inline?: TokenizerExtensionFunction[];
|
||||
block?: TokenizerExtensionFunction[];
|
||||
startInline?: TokenizerStartFunction[];
|
||||
startBlock?: TokenizerStartFunction[];
|
||||
};
|
||||
/**
|
||||
* walkTokens function returns array of values for Promise.all
|
||||
*/
|
||||
walkTokens?: null | ((token: Token) => void | Promise<void> | (void | Promise<void>)[]);
|
||||
}
|
||||
/**
|
||||
* Block Lexer
|
||||
*/
|
||||
declare class _Lexer<ParserOutput = string, RendererOutput = string> {
|
||||
tokens: TokensList;
|
||||
options: MarkedOptions<ParserOutput, RendererOutput>;
|
||||
state: {
|
||||
inLink: boolean;
|
||||
inRawBlock: boolean;
|
||||
top: boolean;
|
||||
};
|
||||
inlineQueue: {
|
||||
src: string;
|
||||
tokens: Token[];
|
||||
}[];
|
||||
private tokenizer;
|
||||
constructor(options?: MarkedOptions<ParserOutput, RendererOutput>);
|
||||
/**
|
||||
* Expose Rules
|
||||
*/
|
||||
static get rules(): {
|
||||
block: {
|
||||
normal: {
|
||||
blockquote: RegExp;
|
||||
code: RegExp;
|
||||
def: RegExp;
|
||||
fences: RegExp;
|
||||
heading: RegExp;
|
||||
hr: RegExp;
|
||||
html: RegExp;
|
||||
lheading: RegExp;
|
||||
list: RegExp;
|
||||
newline: RegExp;
|
||||
paragraph: RegExp;
|
||||
table: RegExp;
|
||||
text: RegExp;
|
||||
};
|
||||
gfm: Record<"code" | "blockquote" | "hr" | "html" | "table" | "text" | "def" | "heading" | "list" | "paragraph" | "fences" | "lheading" | "newline", RegExp>;
|
||||
pedantic: Record<"code" | "blockquote" | "hr" | "html" | "table" | "text" | "def" | "heading" | "list" | "paragraph" | "fences" | "lheading" | "newline", RegExp>;
|
||||
};
|
||||
inline: {
|
||||
normal: {
|
||||
_backpedal: RegExp;
|
||||
anyPunctuation: RegExp;
|
||||
autolink: RegExp;
|
||||
blockSkip: RegExp;
|
||||
br: RegExp;
|
||||
code: RegExp;
|
||||
del: RegExp;
|
||||
delLDelim: RegExp;
|
||||
delRDelim: RegExp;
|
||||
emStrongLDelim: RegExp;
|
||||
emStrongRDelimAst: RegExp;
|
||||
emStrongRDelimUnd: RegExp;
|
||||
escape: RegExp;
|
||||
link: RegExp;
|
||||
nolink: RegExp;
|
||||
punctuation: RegExp;
|
||||
reflink: RegExp;
|
||||
reflinkSearch: RegExp;
|
||||
tag: RegExp;
|
||||
text: RegExp;
|
||||
url: RegExp;
|
||||
};
|
||||
gfm: Record<"link" | "code" | "url" | "br" | "del" | "text" | "tag" | "escape" | "reflink" | "nolink" | "_backpedal" | "anyPunctuation" | "autolink" | "blockSkip" | "delLDelim" | "delRDelim" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
|
||||
breaks: Record<"link" | "code" | "url" | "br" | "del" | "text" | "tag" | "escape" | "reflink" | "nolink" | "_backpedal" | "anyPunctuation" | "autolink" | "blockSkip" | "delLDelim" | "delRDelim" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
|
||||
pedantic: Record<"link" | "code" | "url" | "br" | "del" | "text" | "tag" | "escape" | "reflink" | "nolink" | "_backpedal" | "anyPunctuation" | "autolink" | "blockSkip" | "delLDelim" | "delRDelim" | "emStrongLDelim" | "emStrongRDelimAst" | "emStrongRDelimUnd" | "punctuation" | "reflinkSearch", RegExp>;
|
||||
};
|
||||
};
|
||||
/**
|
||||
* Static Lex Method
|
||||
*/
|
||||
static lex<ParserOutput = string, RendererOutput = string>(src: string, options?: MarkedOptions<ParserOutput, RendererOutput>): TokensList;
|
||||
/**
|
||||
* Static Lex Inline Method
|
||||
*/
|
||||
static lexInline<ParserOutput = string, RendererOutput = string>(src: string, options?: MarkedOptions<ParserOutput, RendererOutput>): Token[];
|
||||
/**
|
||||
* Preprocessing
|
||||
*/
|
||||
lex(src: string): TokensList;
|
||||
/**
|
||||
* Lexing
|
||||
*/
|
||||
blockTokens(src: string, tokens?: Token[], lastParagraphClipped?: boolean): Token[];
|
||||
blockTokens(src: string, tokens?: TokensList, lastParagraphClipped?: boolean): TokensList;
|
||||
inline(src: string, tokens?: Token[]): Token[];
|
||||
/**
|
||||
* Lexing/Compiling
|
||||
*/
|
||||
inlineTokens(src: string, tokens?: Token[]): Token[];
|
||||
private infiniteLoopError;
|
||||
}
|
||||
export type MaybePromise = void | Promise<void>;
|
||||
export declare class Marked<ParserOutput = string, RendererOutput = string> {
|
||||
defaults: MarkedOptions<ParserOutput, RendererOutput>;
|
||||
options: (opt: MarkedOptions<ParserOutput, RendererOutput>) => this;
|
||||
/**
|
||||
* Compiles markdown to HTML.
|
||||
*
|
||||
* To configure hooks, a renderer, or a tokenizer, create a separate `Marked`
|
||||
* instance and use `Marked#use` instead of passing them on each call.
|
||||
*/
|
||||
parse: {
|
||||
(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
|
||||
async: true;
|
||||
}): Promise<ParserOutput>;
|
||||
(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
|
||||
async: false;
|
||||
}): ParserOutput;
|
||||
(src: string, options?: MarkedOptions<ParserOutput, RendererOutput> | null): ParserOutput | Promise<ParserOutput>;
|
||||
};
|
||||
/**
|
||||
* Compiles inline markdown to HTML.
|
||||
*
|
||||
* To configure hooks, a renderer, or a tokenizer, create a separate `Marked`
|
||||
* instance and use `Marked#use` instead of passing them on each call.
|
||||
*/
|
||||
parseInline: {
|
||||
(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
|
||||
async: true;
|
||||
}): Promise<ParserOutput>;
|
||||
(src: string, options: MarkedOptions<ParserOutput, RendererOutput> & {
|
||||
async: false;
|
||||
}): ParserOutput;
|
||||
(src: string, options?: MarkedOptions<ParserOutput, RendererOutput> | null): ParserOutput | Promise<ParserOutput>;
|
||||
};
|
||||
Parser: {
|
||||
new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Parser<ParserOutput, RendererOutput>;
|
||||
parse<ParserOutput_1 = string, RendererOutput_1 = string>(tokens: Token[], options?: MarkedOptions<ParserOutput_1, RendererOutput_1>): ParserOutput_1;
|
||||
parseInline<ParserOutput_1 = string, RendererOutput_1 = string>(tokens: Token[], options?: MarkedOptions<ParserOutput_1, RendererOutput_1>): ParserOutput_1;
|
||||
};
|
||||
Renderer: {
|
||||
new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Renderer<ParserOutput, RendererOutput>;
|
||||
};
|
||||
TextRenderer: {
|
||||
new (): _TextRenderer<RendererOutput>;
|
||||
};
|
||||
Lexer: typeof _Lexer;
|
||||
Tokenizer: {
|
||||
new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Tokenizer<ParserOutput, RendererOutput>;
|
||||
};
|
||||
Hooks: {
|
||||
new (options?: MarkedOptions<ParserOutput, RendererOutput> | undefined): _Hooks<ParserOutput, RendererOutput>;
|
||||
passThroughHooks: Set<string>;
|
||||
passThroughHooksRespectAsync: Set<string>;
|
||||
};
|
||||
constructor(...args: MarkedExtension<ParserOutput, RendererOutput>[]);
|
||||
/**
|
||||
* Run callback for every token
|
||||
*/
|
||||
walkTokens(tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]): MaybePromise[];
|
||||
/**
|
||||
* Registers extensions with this Marked instance.
|
||||
*
|
||||
* The `renderer`, `tokenizer`, and `hooks` objects may each contain only the
|
||||
* methods that should be overridden. Their methods are merged with built-in
|
||||
* behavior and extensions registered by earlier calls.
|
||||
*
|
||||
* Use this method when supplying only some hook methods.
|
||||
*/
|
||||
use(...args: MarkedExtension<ParserOutput, RendererOutput>[]): this;
|
||||
setOptions(opt: MarkedOptions<ParserOutput, RendererOutput>): this;
|
||||
lexer(src: string, options?: MarkedOptions<ParserOutput, RendererOutput>): TokensList;
|
||||
parser(tokens: Token[], options?: MarkedOptions<ParserOutput, RendererOutput>): ParserOutput;
|
||||
private parseMarkdown;
|
||||
private onError;
|
||||
}
|
||||
/**
|
||||
* Gets the original marked default options.
|
||||
*/
|
||||
declare function _getDefaults<ParserOutput = string, RendererOutput = string>(): MarkedOptions<ParserOutput, RendererOutput>;
|
||||
declare let _defaults: MarkedOptions<any, any>;
|
||||
declare const markedInstance: Marked<string, string>;
|
||||
/**
|
||||
* Compiles markdown to HTML asynchronously.
|
||||
*
|
||||
* To configure hooks, a renderer, or a tokenizer, create a `Marked` instance
|
||||
* and use `Marked#use` instead of passing them as options on each call.
|
||||
*
|
||||
* @param src String of markdown source to be compiled
|
||||
* @param options Hash of options, having async: true
|
||||
* @return Promise of string of compiled HTML
|
||||
*/
|
||||
export declare function marked(src: string, options: MarkedOptions & {
|
||||
async: true;
|
||||
}): Promise<string>;
|
||||
/**
|
||||
* Compiles markdown to HTML.
|
||||
*
|
||||
* To configure hooks, a renderer, or a tokenizer, create a `Marked` instance
|
||||
* and use `Marked#use` instead of passing them as options on each call.
|
||||
*
|
||||
* @param src String of markdown source to be compiled
|
||||
* @param options Optional hash of options
|
||||
* @return String of compiled HTML. Will be a Promise of string if async is set to true by any extensions.
|
||||
*/
|
||||
export declare function marked(src: string, options: MarkedOptions & {
|
||||
async: false;
|
||||
}): string;
|
||||
export declare function marked(src: string, options: MarkedOptions & {
|
||||
async: true;
|
||||
}): Promise<string>;
|
||||
export declare function marked(src: string, options?: MarkedOptions | null): string | Promise<string>;
|
||||
export declare namespace marked {
|
||||
var options: (options: MarkedOptions) => typeof marked;
|
||||
var setOptions: (options: MarkedOptions) => typeof marked;
|
||||
var getDefaults: typeof _getDefaults;
|
||||
var defaults: MarkedOptions<any, any>;
|
||||
var walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
|
||||
var Parser: typeof _Parser;
|
||||
var parser: typeof _Parser.parse;
|
||||
var Renderer: typeof _Renderer;
|
||||
var TextRenderer: typeof _TextRenderer;
|
||||
var Lexer: typeof _Lexer;
|
||||
var lexer: typeof _Lexer.lex;
|
||||
var Tokenizer: typeof _Tokenizer;
|
||||
var Hooks: typeof _Hooks;
|
||||
var parse: typeof marked;
|
||||
}
|
||||
export declare namespace marked {
|
||||
/**
|
||||
* Compiles inline markdown to HTML.
|
||||
*
|
||||
* To configure hooks, a renderer, or a tokenizer, create a `Marked` instance
|
||||
* and use `Marked#use` instead of passing them as options on each call.
|
||||
*/
|
||||
let parseInline: typeof markedInstance.parseInline;
|
||||
/**
|
||||
* Registers extensions with the default Marked instance.
|
||||
*
|
||||
* The `renderer`, `tokenizer`, and `hooks` objects may each contain only the
|
||||
* methods that should be overridden. Their methods are merged with built-in
|
||||
* behavior and extensions registered by earlier calls.
|
||||
*
|
||||
* Use this function when supplying only some hook methods.
|
||||
*/
|
||||
let use: (...args: MarkedExtension[]) => typeof marked;
|
||||
}
|
||||
/**
|
||||
* Registers extensions with the default Marked instance.
|
||||
*
|
||||
* The `renderer`, `tokenizer`, and `hooks` objects may each contain only the
|
||||
* methods that should be overridden. Their methods are merged with built-in
|
||||
* behavior and extensions registered by earlier calls.
|
||||
*
|
||||
* Use this function when supplying only some hook methods.
|
||||
*
|
||||
* @param args Extensions to register
|
||||
* @return The `marked` function
|
||||
*/
|
||||
declare function useExtension(...args: MarkedExtension[]): typeof marked;
|
||||
export declare const options: (options: MarkedOptions) => typeof marked;
|
||||
export declare const setOptions: (options: MarkedOptions) => typeof marked;
|
||||
export declare const walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
|
||||
/**
|
||||
* Compiles inline markdown to HTML.
|
||||
*
|
||||
* To configure hooks, a renderer, or a tokenizer, create a `Marked` instance
|
||||
* and use `Marked#use` instead of passing them as options on each call.
|
||||
*/
|
||||
export declare const parseInline: {
|
||||
(src: string, options: MarkedOptions<string, string> & {
|
||||
async: true;
|
||||
}): Promise<string>;
|
||||
(src: string, options: MarkedOptions<string, string> & {
|
||||
async: false;
|
||||
}): string;
|
||||
(src: string, options?: MarkedOptions<string, string> | null | undefined): string | Promise<string>;
|
||||
};
|
||||
export declare const parse: typeof marked;
|
||||
export declare const parser: typeof _Parser.parse;
|
||||
export declare const lexer: typeof _Lexer.lex;
|
||||
|
||||
export {
|
||||
_Hooks as Hooks,
|
||||
_Lexer as Lexer,
|
||||
_Parser as Parser,
|
||||
_Renderer as Renderer,
|
||||
_TextRenderer as TextRenderer,
|
||||
_Tokenizer as Tokenizer,
|
||||
_defaults as defaults,
|
||||
_getDefaults as getDefaults,
|
||||
useExtension as use,
|
||||
};
|
||||
|
||||
export {};
|
||||
78
web/node_modules/marked/lib/marked.esm.js
generated
vendored
Normal file
78
web/node_modules/marked/lib/marked.esm.js
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
7
web/node_modules/marked/lib/marked.esm.js.map
generated
vendored
Normal file
7
web/node_modules/marked/lib/marked.esm.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
80
web/node_modules/marked/lib/marked.umd.js
generated
vendored
Normal file
80
web/node_modules/marked/lib/marked.umd.js
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
7
web/node_modules/marked/lib/marked.umd.js.map
generated
vendored
Normal file
7
web/node_modules/marked/lib/marked.umd.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
113
web/node_modules/marked/man/marked.1
generated
vendored
Normal file
113
web/node_modules/marked/man/marked.1
generated
vendored
Normal file
@@ -0,0 +1,113 @@
|
||||
.TH "MARKED" "1" "August 2026" "18.0.8"
|
||||
.SH "NAME"
|
||||
\fBmarked\fR \- a javascript markdown parser
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
\fBmarked\fP [\fB\-o\fP <output file>] [\fB\-i\fP <input file>] [\fB\-s\fP <markdown string>] [\fB\-c\fP <config file>] [\fB\-\-help\fP] [\fB\-\-version\fP] [\fB\-\-tokens\fP] [\fB\-\-no\-clobber\fP] [\fB\-\-pedantic\fP] [\fB\-\-gfm\fP] [\fB\-\-breaks\fP] [\fB\-\-no\-etc\.\.\.\fP] [\fB\-\-silent\fP] [filename]
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
marked is a full\-featured javascript markdown parser, built for speed\.
|
||||
.br
|
||||
It also includes multiple GFM features\.
|
||||
.SH EXAMPLES
|
||||
.RS 2
|
||||
.nf
|
||||
cat in\.md | marked > out\.html
|
||||
.fi
|
||||
.RE
|
||||
.RS 2
|
||||
.nf
|
||||
echo "hello *world*" | marked
|
||||
.fi
|
||||
.RE
|
||||
.RS 2
|
||||
.nf
|
||||
marked \-o out\.html \-i in\.md \-\-gfm
|
||||
.fi
|
||||
.RE
|
||||
.RS 2
|
||||
.nf
|
||||
marked \-\-output="hello world\.html" \-i in\.md \-\-no\-breaks
|
||||
.fi
|
||||
.RE
|
||||
.SH OPTIONS
|
||||
|
||||
.RS 1
|
||||
.IP \(bu 2
|
||||
\-o, \-\-output [output file]
|
||||
.br
|
||||
Specify file output\. If none is specified, write to stdout\.
|
||||
.IP \(bu 2
|
||||
\-i, \-\-input [input file]
|
||||
.br
|
||||
Specify file input, otherwise use last argument as input file\.
|
||||
.br
|
||||
If no input file is specified, read from stdin\.
|
||||
.IP \(bu 2
|
||||
\-s, \-\-string [markdown string]
|
||||
.br
|
||||
Specify string input instead of a file\.
|
||||
.IP \(bu 2
|
||||
\-c, \-\-config [config file]
|
||||
.br
|
||||
Specify config file to use instead of the default \fB~/\.marked\.json\fP or \fB~/\.marked\.js\fP or \fB~/\.marked/index\.js\fP\|\.
|
||||
.IP \(bu 2
|
||||
\-t, \-\-tokens
|
||||
.br
|
||||
Output a token list instead of html\.
|
||||
.IP \(bu 2
|
||||
\-n, \-\-no\-clobber
|
||||
.br
|
||||
Do not overwrite \fBoutput\fP if it exists\.
|
||||
.IP \(bu 2
|
||||
\-\-pedantic
|
||||
.br
|
||||
Conform to obscure parts of markdown\.pl as much as possible\.
|
||||
.br
|
||||
Don't fix original markdown bugs\.
|
||||
.IP \(bu 2
|
||||
\-\-gfm
|
||||
.br
|
||||
Enable github flavored markdown\.
|
||||
.IP \(bu 2
|
||||
\-\-breaks
|
||||
.br
|
||||
Enable GFM line breaks\. Only works with the gfm option\.
|
||||
.IP \(bu 2
|
||||
\-\-no\-breaks, \-no\-etc\.\.\.
|
||||
.br
|
||||
The inverse of any of the marked options above\.
|
||||
.IP \(bu 2
|
||||
\-\-silent
|
||||
.br
|
||||
Silence error output\.
|
||||
.IP \(bu 2
|
||||
\-h, \-\-help
|
||||
.br
|
||||
Display help information\.
|
||||
|
||||
.RE
|
||||
.SH CONFIGURATION
|
||||
.P
|
||||
For configuring and running programmatically\.
|
||||
.P
|
||||
Example
|
||||
.RS 2
|
||||
.nf
|
||||
import { Marked } from 'marked';
|
||||
const marked = new Marked({ gfm: true });
|
||||
marked\.parse('*foo*');
|
||||
.fi
|
||||
.RE
|
||||
.SH BUGS
|
||||
.P
|
||||
Please report any bugs to https://github.com/markedjs/marked
|
||||
.SH LICENSE
|
||||
.P
|
||||
Copyright (c) 2018+, MarkedJS\. (MIT License)
|
||||
.br
|
||||
Copyright (c) 2011\-2018, Christopher Jeffrey\. (MIT License)
|
||||
.SH SEE ALSO
|
||||
.P
|
||||
markdown(1), nodejs(1)
|
||||
|
||||
93
web/node_modules/marked/man/marked.1.md
generated
vendored
Normal file
93
web/node_modules/marked/man/marked.1.md
generated
vendored
Normal file
@@ -0,0 +1,93 @@
|
||||
# marked(1) -- a javascript markdown parser
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
`marked` [`-o` <output file>] [`-i` <input file>] [`-s` <markdown string>] [`-c` <config file>] [`--help`] [`--version`] [`--tokens`] [`--no-clobber`] [`--pedantic`] [`--gfm`] [`--breaks`] [`--no-etc...`] [`--silent`] [filename]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
marked is a full-featured javascript markdown parser, built for speed.
|
||||
It also includes multiple GFM features.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
```sh
|
||||
cat in.md | marked > out.html
|
||||
```
|
||||
|
||||
```sh
|
||||
echo "hello *world*" | marked
|
||||
```
|
||||
|
||||
```sh
|
||||
marked -o out.html -i in.md --gfm
|
||||
```
|
||||
|
||||
```sh
|
||||
marked --output="hello world.html" -i in.md --no-breaks
|
||||
```
|
||||
|
||||
## OPTIONS
|
||||
|
||||
* -o, --output [output file]
|
||||
Specify file output. If none is specified, write to stdout.
|
||||
|
||||
* -i, --input [input file]
|
||||
Specify file input, otherwise use last argument as input file.
|
||||
If no input file is specified, read from stdin.
|
||||
|
||||
* -s, --string [markdown string]
|
||||
Specify string input instead of a file.
|
||||
|
||||
* -c, --config [config file]
|
||||
Specify config file to use instead of the default `~/.marked.json` or `~/.marked.js` or `~/.marked/index.js`.
|
||||
|
||||
* -t, --tokens
|
||||
Output a token list instead of html.
|
||||
|
||||
* -n, --no-clobber
|
||||
Do not overwrite `output` if it exists.
|
||||
|
||||
* --pedantic
|
||||
Conform to obscure parts of markdown.pl as much as possible.
|
||||
Don't fix original markdown bugs.
|
||||
|
||||
* --gfm
|
||||
Enable github flavored markdown.
|
||||
|
||||
* --breaks
|
||||
Enable GFM line breaks. Only works with the gfm option.
|
||||
|
||||
* --no-breaks, -no-etc...
|
||||
The inverse of any of the marked options above.
|
||||
|
||||
* --silent
|
||||
Silence error output.
|
||||
|
||||
* -h, --help
|
||||
Display help information.
|
||||
|
||||
## CONFIGURATION
|
||||
|
||||
For configuring and running programmatically.
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
import { Marked } from 'marked';
|
||||
const marked = new Marked({ gfm: true });
|
||||
marked.parse('*foo*');
|
||||
```
|
||||
|
||||
## BUGS
|
||||
|
||||
Please report any bugs to <https://github.com/markedjs/marked>.
|
||||
|
||||
## LICENSE
|
||||
|
||||
Copyright (c) 2018+, MarkedJS. (MIT License)
|
||||
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
markdown(1), nodejs(1)
|
||||
103
web/node_modules/marked/package.json
generated
vendored
Normal file
103
web/node_modules/marked/package.json
generated
vendored
Normal file
@@ -0,0 +1,103 @@
|
||||
{
|
||||
"name": "marked",
|
||||
"description": "A markdown parser built for speed",
|
||||
"author": "Christopher Jeffrey",
|
||||
"version": "18.0.9",
|
||||
"type": "module",
|
||||
"main": "./lib/marked.esm.js",
|
||||
"module": "./lib/marked.esm.js",
|
||||
"browser": "./lib/marked.umd.js",
|
||||
"types": "./lib/marked.d.ts",
|
||||
"bin": {
|
||||
"marked": "bin/marked.js"
|
||||
},
|
||||
"man": "./man/marked.1",
|
||||
"files": [
|
||||
"bin/",
|
||||
"lib/",
|
||||
"man/"
|
||||
],
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./lib/marked.d.ts",
|
||||
"default": "./lib/marked.esm.js"
|
||||
},
|
||||
"./bin/marked": "./bin/marked.js",
|
||||
"./package.json": "./package.json"
|
||||
},
|
||||
"publishConfig": {
|
||||
"provenance": true
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/markedjs/marked.git"
|
||||
},
|
||||
"homepage": "https://marked.js.org",
|
||||
"bugs": {
|
||||
"url": "https://github.com/markedjs/marked/issues"
|
||||
},
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"markdown",
|
||||
"markup",
|
||||
"html"
|
||||
],
|
||||
"tags": [
|
||||
"markdown",
|
||||
"markup",
|
||||
"html"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@arethetypeswrong/cli": "^0.18.5",
|
||||
"@markedjs/eslint-config": "^1.0.14",
|
||||
"@markedjs/testutils": "18.0.0-1",
|
||||
"@semantic-release/commit-analyzer": "^13.0.1",
|
||||
"@semantic-release/git": "^11.0.1",
|
||||
"@semantic-release/github": "^12.0.9",
|
||||
"@semantic-release/npm": "^13.1.5",
|
||||
"@semantic-release/release-notes-generator": "^14.1.1",
|
||||
"cheerio": "1.2.0",
|
||||
"commonmark": "0.31.2",
|
||||
"cross-env": "^10.1.0",
|
||||
"dts-bundle-generator": "^9.5.1",
|
||||
"esbuild": "^0.28.1",
|
||||
"esbuild-plugin-umd-wrapper": "^3.0.0",
|
||||
"eslint": "^10.8.0",
|
||||
"highlight.js": "^11.11.1",
|
||||
"markdown-it": "14.3.0",
|
||||
"marked-highlight": "^2.2.4",
|
||||
"marked-man": "^2.1.1",
|
||||
"recheck": "^4.5.0",
|
||||
"rimraf": "^6.1.3",
|
||||
"semantic-release": "^25.0.8",
|
||||
"titleize": "^4.0.0",
|
||||
"tslib": "^2.8.1",
|
||||
"typescript": "6.0.3"
|
||||
},
|
||||
"scripts": {
|
||||
"bench": "npm run build && node test/bench.js",
|
||||
"build": "npm run build:esbuild && npm run build:types && npm run build:man",
|
||||
"build:docs": "npm run build && node docs/build.js",
|
||||
"build:esbuild": "node esbuild.config.js",
|
||||
"build:man": "marked-man man/marked.1.md > man/marked.1",
|
||||
"build:reset": "rimraf ./lib ./public",
|
||||
"build:types": "tsc && dts-bundle-generator --export-referenced-types --project tsconfig.json -o lib/marked.d.ts src/marked.ts",
|
||||
"lint": "eslint --fix",
|
||||
"rules": "node test/rules.js",
|
||||
"test": "npm run build:reset && npm run build:docs && npm run test:specs && npm run test:unit && npm run test:umd && npm run test:cjs && npm run test:types && npm run test:lint",
|
||||
"test:cjs": "node test/cjs-test.cjs",
|
||||
"test:lint": "eslint",
|
||||
"test:only": "npm run build && npm run test:specs:only && npm run test:unit:only",
|
||||
"test:redos": "node test/recheck.ts > vuln.js",
|
||||
"test:specs:only": "node --test --test-only --test-reporter=spec test/run-spec-tests.js",
|
||||
"test:specs": "node --test --test-reporter=spec test/run-spec-tests.js",
|
||||
"test:types": "tsc --project tsconfig-type-test.json && attw -P --entrypoints . --profile esm-only",
|
||||
"test:umd": "node test/umd-test.js",
|
||||
"test:unit:only": "node --test --test-only --test-reporter=spec test/unit/*.test.js",
|
||||
"test:unit": "node --test --test-reporter=spec test/unit/*.test.js",
|
||||
"test:update": "node test/update-specs.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 20"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user