Skip to content
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

Jump to bottom

Markdownlint: note-box-headings custom rule #28372

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Markdownlint: note-box-headings custom rule #28372

wants to merge 16 commits into from
+306 −12

Commits on Jul 9, 2024

  1. Add note box heading level test file

    @MaoShizhong
    MaoShizhong committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    74e1a09 View commit details
    Browse the repository at this point in the history

  2. Write note box heading level custom rule 

    Add to markdownlint config custom rules array
    @MaoShizhong
    MaoShizhong committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    c5e655e View commit details
    Browse the repository at this point in the history

  3. Add doc file

    @MaoShizhong
    MaoShizhong committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    fadf9a1 View commit details
    Browse the repository at this point in the history

Commits on Aug 25, 2024

  1. Rename to TOP011 

    Original propose TOP011 closed
    @MaoShizhong
    MaoShizhong committed Aug 25, 2024
    Configuration menu
    Copy the full SHA
    54403c1 View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2024

  1. Rename lint rule 

    Now made generic for multiple aspects of note box headings
    @MaoShizhong
    MaoShizhong committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    bbe5767 View commit details
    Browse the repository at this point in the history

  2. Amend test file with new TOP011 error examples

    @MaoShizhong
    MaoShizhong committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    55384cc View commit details
    Browse the repository at this point in the history

  3. Enforce level 4 headings for all note boxes 

    3 different types of note box heading errors now
- missing heading
- incorrect heading level
- incorrect heading start text (type-dependent)

Will help make note boxes more accessible (linkable via heading id
fragment, and note box type not limited to visual differences and div class).
    @MaoShizhong
    MaoShizhong committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    567c261 View commit details
    Browse the repository at this point in the history

  4. Amend TOP011 docs with new rule intent/rationale

    @MaoShizhong
    MaoShizhong committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    257e01d View commit details
    Browse the repository at this point in the history

  5. Merge branch 'main' into feature/markdownlint-note-box-heading-level

    @MaoShizhong
    MaoShizhong committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    2fb0156 View commit details
    Browse the repository at this point in the history

  6. Enforce note box heading rules in layout style guide

    @MaoShizhong
    MaoShizhong committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    6e25348 View commit details
    Browse the repository at this point in the history

  7. Fix doc typo

    @MaoShizhong
    MaoShizhong committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    3e478e3 View commit details
    Browse the repository at this point in the history

Commits on Oct 3, 2024

  1. Remove debug logging

    @MaoShizhong
    MaoShizhong authored Oct 3, 2024
    Configuration menu
    Copy the full SHA
    2e2ec7e View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into feature/markdownlint-note-box-heading-level

    @MaoShizhong
    MaoShizhong authored Oct 3, 2024
    Configuration menu
    Copy the full SHA
    539324d View commit details
    Browse the repository at this point in the history

Commits on Oct 19, 2024

  1. Fix note box headings in lesson template/example 

    To follow this new lint rule.
    @MaoShizhong
    MaoShizhong committed Oct 19, 2024
    Configuration menu
    Copy the full SHA
    55fbe68 View commit details
    Browse the repository at this point in the history

  2. Enforce space after :

    @MaoShizhong
    MaoShizhong committed Oct 19, 2024
    Configuration menu
    Copy the full SHA
    8da5407 View commit details
    Browse the repository at this point in the history

Commits on Nov 19, 2024

  1. Use US spelling 

    Fix formatting
    @MaoShizhong
    MaoShizhong committed Nov 19, 2024
    Configuration menu
    Copy the full SHA
    f191baf View commit details
    Browse the repository at this point in the history