cssdoc

Appearance

@cssdoc/cssdoc ​

@cssdoc/cssdoc — the programmatic API in a single install. This umbrella package re-exports the three browser-safe building blocks so you can import { parseCssDocs, createIndex, lintModel } from "@cssdoc/cssdoc" instead of wiring up the scoped packages yourself:

Loading cssdoc.json files is Node-only, so it stays in its own package — add @cssdoc/config alongside this one when you need it.

Example ​

ts
import { parseCssDocs, createIndex, lintModel } from "@cssdoc/cssdoc";

const model = parseCssDocs(css);
const findings = lintModel(createIndex(css));

Interfaces ​

Type Aliases ​

Variables ​

Functions ​

References ​

ASPECTS ​

Re-exports ASPECTS

checkClassUsage ​

Re-exports checkClassUsage

checkPropertyAssignments ​

Re-exports checkPropertyAssignments

checkPropertyUsage ​

Re-exports checkPropertyUsage

ClassUsage ​

Re-exports ClassUsage

completeClasses ​

Re-exports completeClasses

completeCustomProperties ​

Re-exports completeCustomProperties

completeFunctions ​

Re-exports completeFunctions

createIndex ​

Re-exports createIndex

CssAnimation ​

Re-exports CssAnimation

CssCondition ​

Re-exports CssCondition

CssDocConfiguration ​

Re-exports CssDocConfiguration

CssDocEntry ​

Re-exports CssDocEntry

CssDocIndex ​

Re-exports CssDocIndex

CssDocManifest ​

Re-exports CssDocManifest

CssDocSyntaxKind ​

Re-exports CssDocSyntaxKind

CssDocTagDefinition ​

Re-exports CssDocTagDefinition

CssDocTagDefinitionOptions ​

Re-exports CssDocTagDefinitionOptions

CssFunction ​

Re-exports CssFunction

CssLayer ​

Re-exports CssLayer

CssModifier ​

Re-exports CssModifier

CssParse ​

Re-exports CssParse

CssPart ​

Re-exports CssPart

CssPropertyDeclared ​

Re-exports CssPropertyDeclared

CssRecordKind ​

Re-exports CssRecordKind

CssRelated ​

Re-exports CssRelated

CssReleaseStage ​

Re-exports CssReleaseStage

CssSlot ​

Re-exports CssSlot

CssSource ​

Re-exports CssSource

CssState ​

Re-exports CssState

CssTokenConsumed ​

Re-exports CssTokenConsumed

cssValueSites ​

Re-exports cssValueSites

CssValueSites ​

Re-exports CssValueSites

DEFAULT_MODIFIER_CONVENTION ​

Re-exports DEFAULT_MODIFIER_CONVENTION

DEFAULT_PSEUDO_ELEMENTS ​

Re-exports DEFAULT_PSEUDO_ELEMENTS

DEFAULT_STATE_PSEUDO_CLASSES ​

Re-exports DEFAULT_STATE_PSEUDO_CLASSES

definitionForClass ​

Re-exports definitionForClass

definitionForCustomProperty ​

Re-exports definitionForCustomProperty

definitionForFunction ​

Re-exports definitionForFunction

DocCondition ​

Re-exports DocCondition

DocCssProperty ​

Re-exports DocCssProperty

DocModifier ​

Re-exports DocModifier

hoverForClass ​

Re-exports hoverForClass

hoverForCustomProperty ​

Re-exports hoverForCustomProperty

hoverForFunction ​

Re-exports hoverForFunction

indexFromEntries ​

Re-exports indexFromEntries

InlineCommentMode ​

Re-exports InlineCommentMode

lintModel ​

Re-exports lintModel

Location ​

Re-exports Location

memberKey ​

Re-exports memberKey

MemberKind ​

Re-exports MemberKind

MermaidOptions ​

Re-exports MermaidOptions

MODIFIER_PRESETS ​

Re-exports MODIFIER_PRESETS

ModifierConvention ​

Re-exports ModifierConvention

ModifierConventionInput ​

Re-exports ModifierConventionInput

ModifierHit ​

Re-exports ModifierHit

ModifierMatcher ​

Re-exports ModifierMatcher

parseCssDocs ​

Re-exports parseCssDocs

ParsedDoc ​

Re-exports ParsedDoc

parseDocComment ​

Re-exports parseDocComment

ParseOptions ​

Re-exports ParseOptions

parseStructure ​

Re-exports parseStructure

Position ​

Re-exports Position

PropertyAssignment ​

Re-exports PropertyAssignment

PropertyUsage ​

Re-exports PropertyUsage

RECORD_TAGS ​

Re-exports RECORD_TAGS

RecordInfo ​

Re-exports RecordInfo

recordNameOf ​

Re-exports recordNameOf

resolveModifierConvention ​

Re-exports resolveModifierConvention

SourceSpan ​

Re-exports SourceSpan

stripCommentFraming ​

Re-exports stripCommentFraming

StructureNode ​

Re-exports StructureNode

toJson ​

Re-exports toJson

toMermaid ​

Re-exports toMermaid

Released under the MIT License

Copyright © 2026-present iyWahl