Skip to content

🚀 Feature: Add a first-class AST node for Markdown headings #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
- nyankoiscat - (Hikkywannafly) wants to merge 1 commit into from
+33 −0
Closed

🚀 Feature: Add a first-class AST node for Markdown headings #466

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions tsdoc/src/nodes/DocHeading.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.

import { DocNodeKind } from './DocNode';
import { type IDocNodeContainerParameters, DocNodeContainer } from './DocNodeContainer';

export type DocHeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;

export interface IDocHeadingParameters extends IDocNodeContainerParameters {
headingLevel: DocHeadingLevel;
}

export class DocHeading extends DocNodeContainer {
private readonly _headingLevel: DocHeadingLevel;

public constructor(parameters: IDocHeadingParameters) {
super(parameters);

if (!Number.isInteger(parameters.headingLevel) || parameters.headingLevel < 1 || parameters.headingLevel > 6) {
throw new Error('The headingLevel must be an integer between 1 and 6');
}

this._headingLevel = parameters.headingLevel;
}

public get kind(): DocNodeKind.Heading {
return DocNodeKind.Heading;
}

public get headingLevel(): DocHeadingLevel {
return this._headingLevel;
}
}
Loading