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.

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

fix(github): improve formatting of issue template spoilers #311

Commits on Apr 20, 2022

  1. fix(github): improve formatting of issue template spoilers

    - I originally made the spoilers and while they work (and I would say
      improve readability a good bit), there's also some issues with them
      - I've used them a ton more now so know how to workaround most
        of the issues with them now
    
    - fix: use HTML `code` tag inside of `summary` tag, can't use backticks
      - was mixing MD and HTML before, and this doesn't always work and
        didn't work on GitHub, they just had backticks
    
    - fix: don't duplicate the file name in the heading, just make the
      `summary` have a heading inside it instead
      - use an `h4` same as the `####` that it was before
    
    - feat: add syntax highlighting by adding code blocks for each code
      snippet
      - js for rollup.config.js, json5 for tsconfig (it has comments,
        trailing commas, etc (actually a custom parser, but json5 is close
        enough)), json for package.json, and text for verbose logs
      - also, a lot of people sometimes just paste the code with no code
        block and it formats terribly, so this should help defer that
        (as well as any potential issues that can crop up with unindented
        blocks)
        - the `envinfo` text code block seems to be working well, so
          hopefully this will improve issues too
    agilgur5 committed Apr 20, 2022
    Configuration menu
    Copy the full SHA
    795aa80 View commit details
    Browse the repository at this point in the history