uabrc / uabrc/uabrc.github.io

Additional ideas for plugins and linting

Open
#1,095 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dev: enhancement 🛠️✨
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

What would you like to see added?
  • Linting enhancements

    • Title casing
    • "Surround with blank lines" for all block environments. Fixable. Should be configurable for every named block environment. Currently no rule for, e.g., block quotes.
    • New block linting
      • admonitions !!! and ???
      • tabs ===
      • generic pymdownx blocks ///
    • Term normalization
      • Differs from title casing. This checks that common terms are correctly rendered. For example, "Open On Demand" and "Open Ondemand" should be rendered as "Open OnDemand", every time. This may already be possible with a rule in markdownlint, but it may take extra effort due to the whitespace. Fixable with rule mappings.
    • Excess whitespace checker. Looks for hello..world double spaces, for example, and warns/fixes.
    • Enforce particular relative link style
      • Leading dot ./dir/page.md
      • No leading dot dir/page.md
  • Language Server enhancements

    • Treat contents of additional block environments as markdown
      • admonitions !!! and ???
      • tabs ===
      • generic pymdownx blocks ///
  • Plugin enhancements

    • redirects
      • anchor to anchor
      • redirects list in separate file
  • Plugin ideas

    • Check for unlinked files.
      • Glob INFO inclusion, exclusion.
      • Glob WARN inclusion, exclusion.
      • Glob ERR inclusion, exclusion.
      • Repeat for filename suffix inclusion, exclusion.
      • Include all by default. If defined, only include defined.
      • Exclude none by default. If defined, exclude defined.
      • Build set of files from inclusions, exclusions (for each log level)
      • Subtract excludes from includes.
      • Do the thing with the logs based on non-empty sets.
  • Mkdocs enhancements

    • Add plugin hook to add files after other build steps are complete
      • Enables us to generate and add files after pages are built
      • Markdown information can be used to instruct this plugin hook what to do
    • nav in separate file (mkdocs literate nav?)
    • warnings and errors with optional content context, if possible

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points and combines many independent proposals. First narrow it to one enhancement, then locate the corresponding existing linting, language-server, plugin, or MkDocs integration entry point. Define the selected behavior and its validation before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.