ecmarkup

ecmarkup

Version 18.3.1
Published 28 days ago
753 kB
16 dependencies
MIT license

Install

npm i ecmarkup

yarn add ecmarkup

pnpm add ecmarkup

Overview

Custom element definitions and core utilities for markup that specifies ECMAScript and related technologies.

Index

Functions

function build

build: (
    path: string,
    fetch: (path: string, token: CancellationToken) => PromiseLike<string>,
    opts?: Options,
    token?: CancellationToken
) => Promise<Spec>;

Classes

class Boilerplate

class Boilerplate {}

property address

address?: string;

property copyright

copyright?: string;

property license

license?: string;

Interfaces

interface Options

interface Options {}

property assets

assets?: 'none' | 'inline' | 'external';

property assetsDir

assetsDir?: string;

property boilerplate

boilerplate?: Boilerplate;

property contributors

contributors?: string;

property copyright

copyright?: boolean;

property cssOut

cssOut?: never;

property date

date?: Date;

property extraBiblios

extraBiblios?: ExportedBiblio[];

property jsOut

jsOut?: never;

property lintSpec

lintSpec?: boolean;

property location

location?: string;

property log

log?: (msg: string) => void;

property markEffects

markEffects?: boolean;

property multipage

multipage?: boolean;

property oldToc

oldToc?: boolean;

property outfile

outfile?: string;

property shortname

shortname?: string;

property stage

stage?: string | null;

property status

status?: 'proposal' | 'draft' | 'standard';

property title

title?: string;

property toc

toc?: boolean;

property version

version?: string;

property warn

warn?: (err: EcmarkupError) => void;

interface Spec

interface Spec {}

property generatedFiles

generatedFiles: Map<string | null, string | Buffer>;

property namespace

namespace: string;

property opts

opts: Options;

property rootDir

rootDir: string;

property rootPath

rootPath: string;

property spec

spec: this;

method exportBiblio

exportBiblio: () => any;

Type Aliases

type BiblioEntry

type BiblioEntry =
    | AlgorithmBiblioEntry
    | ProductionBiblioEntry
    | ClauseBiblioEntry
    | TermBiblioEntry
    | FigureBiblioEntry
    | StepBiblioEntry;

type EcmarkupError

type EcmarkupError = {
    ruleId: string;
    message: string;
    file?: string;
    source?: string;
    line?: number;
    column?: number;
    nodeType?: string;
};

Package Files (3)

Dependencies (16)

Dev Dependencies (15)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ecmarkup.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ecmarkup)

HTML

<a href="https://www.jsdocs.io/package/ecmarkup"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 25 days ago.
Package analyzed in 3780 ms.
Missing or incorrect documentation? Open an issue for this package.