Skip to content

@cssdoc/dialects

@cssdoc/dialects — resolve a PostCSS parser for a stylesheet dialect, so cssdoc can document .scss/.sass/.less sources (and <style lang="scss"> blocks) the same way it documents plain CSS. Pass the resolved parser as the parse option to parseCssDocs, createIndex, cssValueSites, or lintCssDocs.

Dialect-only constructs ($vars, @mixin, @include, // comments) are parsed but ignored by cssdoc; the doc comments, class selectors, @property at-rules, and custom properties still read.

Example

ts
import { resolveParser, dialectForFilename } from "@cssdoc/dialects";
import { parseCssDocs } from "@cssdoc/core";

const parse = resolveParser(dialectForFilename("theme.scss"));
const records = parseCssDocs(scssSource, { parse });

Type Aliases

Functions

Released under the MIT License