Struct MarkdownLanguage 

pub struct MarkdownLanguage {

    pub allow_math: bool,
    pub allow_tables: bool,
    pub allow_task_lists: bool,
    pub allow_strikethrough: bool,
    pub allow_footnotes: bool,
    pub allow_front_matter: bool,
    pub allow_definition_lists: bool,
    pub allow_subscript: bool,
    pub allow_autolinks: bool,
    pub allow_abbreviations: bool,
    pub allow_indented_code_blocks: bool,
    pub allow_html: bool,
    pub allow_hard_line_breaks: bool,
    pub allow_gfm_autolinks: bool,
    pub allow_headings: bool,
    pub allow_lists: bool,
    pub allow_blockquotes: bool,
    pub allow_fenced_code_blocks: bool,
    pub allow_horizontal_rules: bool,
    pub allow_setext_headings: bool,
    pub allow_html_tagfilter: bool,
    pub allow_xml: bool,
}

Configuration for the Markdown language features.

Fields

allow_math: bool

Enable math formulas.

Example: $a^2 + b^2 = c^2$ or $$E = mc^2$$

allow_tables: bool

Enable tables.

Example:

Header
Cell

allow_task_lists: bool

Enable task lists.

Example: - [ ] Task or - [x] Done

allow_strikethrough: bool

Enable strikethrough.

Example: ~~deleted~~

allow_footnotes: bool

Enable footnotes.

Example: [^1] and [^1]: Note

allow_front_matter: bool

Enable front matter (YAML/TOML/JSON).

Example:

title: Hello

allow_definition_lists: bool

Enable definition lists.

Example: Term : Definition

allow_subscript: bool

Enable superscript and subscript.

Example: ^sup^ or ~sub~

allow_autolinks: bool

Enable autolinks.

Example: <https://example.com>

allow_abbreviations: bool

Enable abbreviations.

Example: *[HTML]: HyperText Markup Language

allow_indented_code_blocks: bool

Enable indented code blocks.

Example: code block

allow_html: bool

Enable inline HTML tags.

Example: <div> or <!-- comment -->

allow_hard_line_breaks: bool

Enable hard line breaks.

Example: Two spaces at the end of a line or a backslash.

allow_gfm_autolinks: bool

Enable GFM-style autolinks.

Example: https://example.com

allow_headings: bool

Enable ATX headings.

Example: # Heading

allow_lists: bool

Enable lists.

Example: - Item or 1. Item

allow_blockquotes: bool

Enable blockquotes.

Example: > Quote

allow_fenced_code_blocks: bool

Enable fenced code blocks.

Example: ```rust

allow_horizontal_rules: bool

Enable horizontal rules.

Example: --- or ***

allow_setext_headings: bool

Enable Setext headings.

Example: Heading

allow_html_tagfilter: bool

Enable GFM Tagfilter.

Filters certain HTML tags like <script>.

allow_xml: bool

Enable XML/TSX syntax.

Example: <Component />

Implementations

impl MarkdownLanguage

pub fn new() -> Self

Creates a new Markdown language configuration with default settings.

Trait Implementations

impl<'config> Builder<MarkdownLanguage> for MarkdownBuilder<'config>

fn build<'a, S: Source + ?Sized>( &self, source: &S, edits: &[TextEdit], _cache: &'a mut impl BuilderCache<MarkdownLanguage>, ) -> BuildOutput<MarkdownLanguage>

Builds the higher-level structure (typically an AST) from the source text.

impl Clone for MarkdownLanguage

fn clone(&self) -> MarkdownLanguage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MarkdownLanguage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MarkdownLanguage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarkdownLanguage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MarkdownLanguage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HoverProvider<MarkdownLanguage> for MarkdownHoverProvider

Available on crate feature lsp only.

fn hover( &self, node: &RedNode<'_, MarkdownLanguage>, _range: Range<usize>, ) -> Option<HoverInfo>

Returns hover information at the given range.

impl Language for MarkdownLanguage

const NAME: &'static str = "markdown"

The name of the language (e.g., “rust”, “sql”).

const CATEGORY: LanguageCategory = LanguageCategory::Markup

The category of the language.

type TokenType = MarkdownTokenType

The token type used to represent different token and node types in the language.

type ElementType = MarkdownElementType

The element type used to represent composite structures in the parsed tree.

type TypedRoot = MarkdownRoot

The root type for the parsed tree that represents the top-level structure of the language.

impl<'config> Lexer<MarkdownLanguage> for MarkdownLexer<'config>

fn lex<'a, S: Source + ?Sized>( &self, text: &'a S, _edits: &[TextEdit], cache: &'a mut impl LexerCache<MarkdownLanguage>, ) -> LexOutput<MarkdownLanguage>

Tokenizes the source text into a sequence of tokens.

impl<'config> Parser<MarkdownLanguage> for MarkdownParser<'config>

fn parse<'a, S: Source + ?Sized>( &self, text: &'a S, edits: &[TextEdit], cache: &'a mut impl ParseCache<MarkdownLanguage>, ) -> ParseOutput<'a, MarkdownLanguage>

The core parsing entry point for converting tokens into a syntax tree.

impl PartialEq for MarkdownLanguage

fn eq(&self, other: &MarkdownLanguage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MarkdownLanguage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MarkdownLanguage

impl Eq for MarkdownLanguage

impl StructuralPartialEq for MarkdownLanguage