---
url: /reference/@cssdoc/cssdoc.md
---
# @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:

* [@cssdoc/core](https://cssdoc.dev) — parse doc-comments + the CSS AST into a model.
* [@cssdoc/index](https://cssdoc.dev) — build a queryable index with source spans.
* [@cssdoc/providers](https://cssdoc.dev) — lint, complete, hover, and go-to-definition.

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

* [Completion](interfaces/Completion.md)
* [Diagnostic](interfaces/Diagnostic.md)
* [DiagnosticFix](interfaces/DiagnosticFix.md)
* [Hover](interfaces/Hover.md)
* [NamingRules](interfaces/NamingRules.md)
* [ResolvedNaming](interfaces/ResolvedNaming.md)
* [ResolvedRuleOptions](interfaces/ResolvedRuleOptions.md)
* [RuleOptions](interfaces/RuleOptions.md)
* [SyntaxMatch](interfaces/SyntaxMatch.md)
* [TextEdit](interfaces/TextEdit.md)
* [UsageOptions](interfaces/UsageOptions.md)

## Type Aliases

* [CompletionKind](type-aliases/CompletionKind.md)
* [HoverDetail](type-aliases/HoverDetail.md)
* [HoverSectionKey](type-aliases/HoverSectionKey.md)
* [HoverSectionMode](type-aliases/HoverSectionMode.md)
* [HoverSectionOrder](type-aliases/HoverSectionOrder.md)
* [HoverSections](type-aliases/HoverSections.md)
* [NameCase](type-aliases/NameCase.md)
* [RuleId](type-aliases/RuleId.md)
* [RuleSeverities](type-aliases/RuleSeverities.md)
* [RuleSeverity](type-aliases/RuleSeverity.md)
* [Severity](type-aliases/Severity.md)

## Variables

* [cssPart](variables/cssPart.md)
* [customProperty](variables/customProperty.md)
* [DEFAULT_RULE_OPTIONS](variables/DEFAULT_RULE_OPTIONS.md)
* [DEFAULT_RULE_SEVERITIES](variables/DEFAULT_RULE_SEVERITIES.md)
* [func](variables/func.md)
* [HOVER_SECTION_KEYS](variables/HOVER_SECTION_KEYS.md)
* [modifier](variables/modifier.md)
* [NAME_CASE_PRESETS](variables/NAME_CASE_PRESETS.md)
* [part](variables/part.md)
* [record](variables/record.md)

## Functions

* [applyDirectives](functions/applyDirectives.md)
* [elementUsage](functions/elementUsage.md)
* [linkSyntax](functions/linkSyntax.md)
* [matchesSyntax](functions/matchesSyntax.md)
* [mdnUrlForType](functions/mdnUrlForType.md)
* [parseDirectives](functions/parseDirectives.md)
* [partUsage](functions/partUsage.md)
* [resolveNaming](functions/resolveNaming.md)
* [resolveRuleOptions](functions/resolveRuleOptions.md)
* [resolveRuleSeverities](functions/resolveRuleSeverities.md)
* [selectorDefines](functions/selectorDefines.md)
* [stateUsage](functions/stateUsage.md)

## References

### ampStaysAtScope

Re-exports [ampStaysAtScope](../core/functions/ampStaysAtScope.md)

***

### ASPECTS

Re-exports [ASPECTS](../providers/variables/ASPECTS.md)

***

### buildCustomMediaDeclarations

Re-exports [buildCustomMediaDeclarations](../core/functions/buildCustomMediaDeclarations.md)

***

### BuildCustomMediaOptions

Re-exports [BuildCustomMediaOptions](../core/interfaces/BuildCustomMediaOptions.md)

***

### cardinalityIsDashed

Re-exports [cardinalityIsDashed](../core/functions/cardinalityIsDashed.md)

***

### cardinalityToken

Re-exports [cardinalityToken](../core/functions/cardinalityToken.md)

***

### checkClassUsage

Re-exports [checkClassUsage](../providers/functions/checkClassUsage.md)

***

### checkPropertyAssignments

Re-exports [checkPropertyAssignments](../providers/functions/checkPropertyAssignments.md)

***

### checkPropertyUsage

Re-exports [checkPropertyUsage](../providers/functions/checkPropertyUsage.md)

***

### ClassUsage

Re-exports [ClassUsage](../index/interfaces/ClassUsage.md)

***

### compileCustomMediaDeclarations

Re-exports [compileCustomMediaDeclarations](../core/functions/compileCustomMediaDeclarations.md)

***

### CompileCustomMediaOptions

Re-exports [CompileCustomMediaOptions](../core/interfaces/CompileCustomMediaOptions.md)

***

### completeClasses

Re-exports [completeClasses](../providers/functions/completeClasses.md)

***

### completeCustomProperties

Re-exports [completeCustomProperties](../providers/functions/completeCustomProperties.md)

***

### completeFunctions

Re-exports [completeFunctions](../providers/functions/completeFunctions.md)

***

### createIndex

Re-exports [createIndex](../index/functions/createIndex.md)

***

### CssAnimation

Re-exports [CssAnimation](../core/interfaces/CssAnimation.md)

***

### CssCondition

Re-exports [CssCondition](../core/interfaces/CssCondition.md)

***

### CssDocConfiguration

Re-exports [CssDocConfiguration](../core/classes/CssDocConfiguration.md)

***

### CssDocEntry

Re-exports [CssDocEntry](../core/interfaces/CssDocEntry.md)

***

### CssDocIndex

Re-exports [CssDocIndex](../index/classes/CssDocIndex.md)

***

### CssDocManifest

Re-exports [CssDocManifest](../index/interfaces/CssDocManifest.md)

***

### CssDocSyntaxKind

Re-exports [CssDocSyntaxKind](../core/type-aliases/CssDocSyntaxKind.md)

***

### CssDocTagDefinition

Re-exports [CssDocTagDefinition](../core/classes/CssDocTagDefinition.md)

***

### CssDocTagDefinitionOptions

Re-exports [CssDocTagDefinitionOptions](../core/interfaces/CssDocTagDefinitionOptions.md)

***

### CssFunction

Re-exports [CssFunction](../core/interfaces/CssFunction.md)

***

### CssLayer

Re-exports [CssLayer](../core/interfaces/CssLayer.md)

***

### CssModifier

Re-exports [CssModifier](../core/interfaces/CssModifier.md)

***

### CssParse

Re-exports [CssParse](../core/type-aliases/CssParse.md)

***

### CssPart

Re-exports [CssPart](../core/interfaces/CssPart.md)

***

### CssPropertyDeclared

Re-exports [CssPropertyDeclared](../core/interfaces/CssPropertyDeclared.md)

***

### CssRecordKind

Re-exports [CssRecordKind](../core/type-aliases/CssRecordKind.md)

***

### CssRelated

Re-exports [CssRelated](../core/interfaces/CssRelated.md)

***

### CssReleaseStage

Re-exports [CssReleaseStage](../core/type-aliases/CssReleaseStage.md)

***

### CssSlot

Re-exports [CssSlot](../core/interfaces/CssSlot.md)

***

### CssSource

Re-exports [CssSource](../core/interfaces/CssSource.md)

***

### CssState

Re-exports [CssState](../core/interfaces/CssState.md)

***

### CssTokenConsumed

Re-exports [CssTokenConsumed](../core/interfaces/CssTokenConsumed.md)

***

### cssValueSites

Re-exports [cssValueSites](../index/functions/cssValueSites.md)

***

### CssValueSites

Re-exports [CssValueSites](../index/interfaces/CssValueSites.md)

***

### CssVisibility

Re-exports [CssVisibility](../core/type-aliases/CssVisibility.md)

***

### DEFAULT_MODIFIER_CONVENTION

Re-exports [DEFAULT_MODIFIER_CONVENTION](../core/variables/DEFAULT_MODIFIER_CONVENTION.md)

***

### DEFAULT_PSEUDO_ELEMENTS

Re-exports [DEFAULT_PSEUDO_ELEMENTS](../core/variables/DEFAULT_PSEUDO_ELEMENTS.md)

***

### DEFAULT_STATE_PSEUDO_CLASSES

Re-exports [DEFAULT_STATE_PSEUDO_CLASSES](../core/variables/DEFAULT_STATE_PSEUDO_CLASSES.md)

***

### definitionForClass

Re-exports [definitionForClass](../providers/functions/definitionForClass.md)

***

### definitionForCustomProperty

Re-exports [definitionForCustomProperty](../providers/functions/definitionForCustomProperty.md)

***

### definitionForFunction

Re-exports [definitionForFunction](../providers/functions/definitionForFunction.md)

***

### DocCondition

Re-exports [DocCondition](../core/interfaces/DocCondition.md)

***

### DocCssProperty

Re-exports [DocCssProperty](../core/interfaces/DocCssProperty.md)

***

### DocModifier

Re-exports [DocModifier](../core/interfaces/DocModifier.md)

***

### ExampleFilter

Re-exports [ExampleFilter](../core/interfaces/ExampleFilter.md)

***

### hoverForClass

Re-exports [hoverForClass](../providers/functions/hoverForClass.md)

***

### hoverForCustomProperty

Re-exports [hoverForCustomProperty](../providers/functions/hoverForCustomProperty.md)

***

### hoverForFunction

Re-exports [hoverForFunction](../providers/functions/hoverForFunction.md)

***

### indexFromEntries

Re-exports [indexFromEntries](../index/functions/indexFromEntries.md)

***

### InlineCommentMode

Re-exports [InlineCommentMode](../core/type-aliases/InlineCommentMode.md)

***

### lintModel

Re-exports [lintModel](../providers/functions/lintModel.md)

***

### Location

Re-exports [Location](../index/interfaces/Location.md)

***

### memberKey

Re-exports [memberKey](../index/functions/memberKey.md)

***

### MemberKind

Re-exports [MemberKind](../index/type-aliases/MemberKind.md)

***

### MermaidOptions

Re-exports [MermaidOptions](../core/interfaces/MermaidOptions.md)

***

### MODIFIER_PRESETS

Re-exports [MODIFIER_PRESETS](../core/variables/MODIFIER_PRESETS.md)

***

### ModifierConvention

Re-exports [ModifierConvention](../core/interfaces/ModifierConvention.md)

***

### ModifierConventionInput

Re-exports [ModifierConventionInput](../core/type-aliases/ModifierConventionInput.md)

***

### ModifierHit

Re-exports [ModifierHit](../core/interfaces/ModifierHit.md)

***

### ModifierMatcher

Re-exports [ModifierMatcher](../core/classes/ModifierMatcher.md)

***

### parseCssDocs

Re-exports [parseCssDocs](../core/functions/parseCssDocs.md)

***

### ParsedDoc

Re-exports [ParsedDoc](../core/interfaces/ParsedDoc.md)

***

### parseDocComment

Re-exports [parseDocComment](../core/functions/parseDocComment.md)

***

### ParseOptions

Re-exports [ParseOptions](../core/interfaces/ParseOptions.md)

***

### parseStructure

Re-exports [parseStructure](../core/functions/parseStructure.md)

***

### parseStructureVariants

Re-exports [parseStructureVariants](../core/functions/parseStructureVariants.md)

***

### Position

Re-exports [Position](../index/interfaces/Position.md)

***

### PropertyAssignment

Re-exports [PropertyAssignment](../index/interfaces/PropertyAssignment.md)

***

### PropertyUsage

Re-exports [PropertyUsage](../index/interfaces/PropertyUsage.md)

***

### RECORD_TAGS

Re-exports [RECORD_TAGS](../core/variables/RECORD_TAGS.md)

***

### RecordInfo

Re-exports [RecordInfo](../index/interfaces/RecordInfo.md)

***

### recordNameOf

Re-exports [recordNameOf](../core/functions/recordNameOf.md)

***

### resolveModifierConvention

Re-exports [resolveModifierConvention](../core/functions/resolveModifierConvention.md)

***

### scopeMatchesBase

Re-exports [scopeMatchesBase](../core/functions/scopeMatchesBase.md)

***

### scopePreludeBase

Re-exports [scopePreludeBase](../core/functions/scopePreludeBase.md)

***

### selectExamples

Re-exports [selectExamples](../core/functions/selectExamples.md)

***

### SourceSpan

Re-exports [SourceSpan](../index/interfaces/SourceSpan.md)

***

### splitModifierArg

Re-exports [splitModifierArg](../core/functions/splitModifierArg.md)

***

### splitPartArg

Re-exports [splitPartArg](../core/functions/splitPartArg.md)

***

### stripCommentFraming

Re-exports [stripCommentFraming](../core/functions/stripCommentFraming.md)

***

### StructureCustomMediaRef

Re-exports [StructureCustomMediaRef](../core/interfaces/StructureCustomMediaRef.md)

***

### structureCustomMediaRefs

Re-exports [structureCustomMediaRefs](../core/functions/structureCustomMediaRefs.md)

***

### StructureNode

Re-exports [StructureNode](../core/interfaces/StructureNode.md)

***

### StructureVariant

Re-exports [StructureVariant](../core/interfaces/StructureVariant.md)

***

### toJson

Re-exports [toJson](../core/functions/toJson.md)

***

### toMermaid

Re-exports [toMermaid](../core/functions/toMermaid.md)

***

### toMermaidVariants

Re-exports [toMermaidVariants](../core/functions/toMermaidVariants.md)
