• Søren Bredlund Caspersen's avatar
    [doc] Reduce markdown lint errors · 80d66951
    Søren Bredlund Caspersen authored
    Reduce number of markdown lint errors by moving indented codeblocks to fenced codeblocks instead.
    Notice in CONTRIBUTING.md and doc/developer-notes.md that the code in lists now render as intended in the mkdocs output.
    
    Test-plan:
    
    - Check out master
    - `markdownlint -c .markdownlint.json -o /tmp/before CONTRIBUTING.md contrib/devtools/README.md contrib/seeds/README.md contrib/testgen/README.md doc/build-osx.md doc/build-unix.md doc/developer-notes.md doc/ninja_targets.md doc/unit-tests.md doc/gitian-building/gitian-building-create-vm-debian.md doc/gitian-building/gitian-building-manual.md`
    - Check out this MR
    - `markdownlint -c .markdownlint.json -o /tmp/after CONTRIBUTING.md contrib/devtools/README.md contrib/seeds/README.md contrib/testgen/README.md doc/build-osx.md doc/build-unix.md doc/developer-notes.md doc/ninja_targets.md doc/unit-tests.md doc/gitian-building/gitian-building-create-vm-debian.md doc/gitian-building/gitian-building-manual.md`
    - Compare the `before` and `after` output files, especially notice there are no MD046 in the `after` file.
    - `mkdocs serve` and browse the affected files. Especially http://localhost:8000/doc/developer-notes/, and notice that the rendered list show the intention of the actual `*.md` file.
    80d66951
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.md 10.7 KB