Skip to main content

API

Basic Usage

import { MLEngine } from 'markuplint';

const file = await MLEngine.toMLFile('./path/to/page.html');

const engine = new MLEngine(file, {
configFile: './path/to/.markuplintrc',
});

engine.on('log', (id, message) => {
console.log(id, message);
});

const result = await engine.exec();

console.log(result.violations);

Packages

PackageNPMPlatform
markuplintnpm versionNode.js
@markuplint/create-rule-helpernpm versionNode.js
@markuplint/html-parsernpm versionUniversal
@markuplint/html-specnpm versionUniversal
@markuplint/i18nnpm versionUniversal
@markuplint/ml-astnpm versionUniversal
@markuplint/ml-confignpm versionUniversal
@markuplint/ml-corenpm versionUniversal
@markuplint/ml-specnpm versionUniversal
@markuplint/parser-utilsnpm versionUniversal
@markuplint/rulesnpm versionUniversal
@markuplint/typesnpm versionUniversal