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

docs: updates to the documentation to support new markdown renderer #3672

Merged
merged 5 commits into from Apr 12, 2021
Merged

docs: updates to the documentation to support new markdown renderer #3672

merged 5 commits into from Apr 12, 2021

Commits on Apr 10, 2021

  1. docs: update docs metadata syntax to work with a new Markdown parser 

    Companion PR for karma-runner/karma-runner.github.com#62.
    @devoto13
    devoto13 committed Apr 10, 2021
    Copy the full SHA
    6438845 View commit details
    Browse the repository at this point in the history

  2. docs: fix invalid heading syntax 

    It is not recognized as a heading by the markdown parser without a whitespace.
    @devoto13
    devoto13 committed Apr 10, 2021
    Copy the full SHA
    762d5c7 View commit details
    Browse the repository at this point in the history

  3. docs: fix weird syntax to reduce diff 

    Old parser considered this the same list, but new parser assumes that these are two separate lists. Technically it should be a nested list, but it is old and shouldn't really matter. I'm doing this change to reduce the diff I need to review after switching to the new markdown parser.
    @devoto13
    devoto13 committed Apr 10, 2021
    Copy the full SHA
    cb5bf4b View commit details
    Browse the repository at this point in the history

  4. docs: fix invalid markdown 

    Items nested in the list item, must be indented 3 spaces, not 2 spaces. New parser produced a pretty messed up markup from the invalid markdown.
    @devoto13
    devoto13 committed Apr 10, 2021
    Copy the full SHA
    3f83491 View commit details
    Browse the repository at this point in the history

  5. docs: remove redundant whitespaces in the list items

    @devoto13
    devoto13 committed Apr 10, 2021
    Copy the full SHA
    51c20e5 View commit details
    Browse the repository at this point in the history