Make Markdown styling consistent across entire guide, establish specific Markdown styling rules #183
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Textual adjustments and enhancements to cios.md - Enhancement of exploit table on get-started.md to be more visually appealing - Addition of tables to priiloader.md to be more visually appealing, in addition to rearrangement in Section IV - Initial addition of images to guide - Greatly expand vwii-finalizing-setup.md with instructions for all three listed homebrew apps, images soon to be added - Add images to vwii-homebrew-channel.md, adjust text - Miscellaneous changes to vwii-homebrew-channel-no-wiiu-mods.md, wiiu-nand-dumper.md
- Fix sidebar display for various pages, remove pages that no longer exist/redirect - Further improvements to get-started.md exploit selection table - Redirect hbc-mini.md to hbd.md - Add exploit page to letterbomb in legacy-exploits.md - Capitalize all occurrences of Wii Menu and Wii U Menu - Give Wii mini/vWii setup finalization pages distinct names - Adjustments based on previous review - Further add images for vWii setup - Grammatical correction in riiconnect24.md - Redirect vwii-homebrew-channel-no-wiiu-mods.md to wiiu-nand-dumper.md - Unify non-mod and mod Wii U paths into one for simplification - Add relevant pages to site-navigation.md, one grammatical correction
backups.md MD004 - Fix inconsistent unordered list style MD009 - Remove trailing spaces MD012 - Remove multiple consecutive blank lines faq.md MD004 - Fix inconsistent unordered list style MD032 - Surround lists with blank lines get-started.md MD047 - End file with a newline osc.md MD004 - Fix inconsistent unordered list style MD047 - End file with a newline
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Markdown reviewed and edited with
markdownlintfor Visual Studio Code, to better align with Markdown best practices and make documents consistentThese changes should optimally have little to no impact on the user facing presentation of content. It should have the intended result of making our jobs easier and making the Markdown we have written more clean and consistent with widely accepted best practices.
Documentation and explanation for referenced fixes at https://github.com/DavidAnson/markdownlint/blob/v0.40.0/README.md
A
.markdownlint.jsonfile is added to the root of the repository to specify markdown styling guidelines for the project.< The following style guidelines are specified >
MD003 - ATX style (#) headings should be used.
MD004 - Unordered lists should be created with the asterisk symbol (*) for consistency.
MD007 - Unordered lists should be indented with 4 spaces, or one press of TAB in a code editor.
MD024 - The same name can only be used for headings with different parents.
MD029 - Ordered lists should be created using the number one (1.) for consistency.
MD033 - Allow <hr>, <br>, <ul>, and <li> as HTML elements inside of GitHub style tables. Additionally allow <br> as HTML elements for usage after headings ONLY as a workaround.
MD035 - Horizontal rules should be created using triple hyphens (---) for consistency.
MD046 - Code blocks should be created as fenced code blocks (like below) for consistency.
MD048 - Code blocks should be created with the backtick symbol (```) for consistency.
MD049 - Emphasis should be specified with the asterisk symbol (*) for consistency.
MD050 - Boldness should be specified with the asterisk symbol (**) for consistency.
MD055 - Tables should be created with leading and trailing pipes for consistency.
MD060 - GitHub style tables are constructed in an aligned style whenever possible.
< The following style guidelines are ignored >
MD013 - Line length (line length regularly surpasses 80 characters)
MD040 - Specifying a language for code blocks (code blocks are used for stylization)
MD045 - Providing alt text for images (need to determine impact)
All document changes begin below.
backups.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
MD012 - Remove multiple consecutive blank lines
bluebomb.md changes:
MD004 - Fix inconsistent unordered list style
MD007 - Fix unordered list indentation
MD009 - Remove trailing spaces
MD010 - Remove hard tabs
MD022 - Surround headings with blank lines
MD031 - Surround code blocks with blank lines
MD032 - Surround lists with blank lines
bootmii.md changes:
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
bootmiirecover.md:
MD004 - Fix inconsistent unordered list style
MD033 - Remove unnecessary inline HTML
bricks.md
MD004 - Fix inconsistent unordered list style
MD005 - Fix inconsistent list indentation
MD007 - Fix unordered list indentation
MD009 - Remove trailing spaces
MD010 - Remove hard tabs
MD022 - Surround headings with blank lines
MD025 - Fix multiple top-level headings
MD032 - Surround lists with blank lines
cios.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
MD012 - Remove multiple consecutive blank lines
MD024 - Fix same headings under the same parent
MD031 - Surround code blocks with blank lines
MD032 - Surround lists with blank lines
MD058 - Surround tables with blank lines
MD059 - Make link text descriptive
dump-games.md
MD004 - Fix inconsistent unordered list style
dump-wads.md
MD047 - End file with a newline
faq.md
MD004 - Fix inconsistent unordered list style
MD007 - Fix unordered list indentation
MD022 - Surround headings with blank lines
MD032 - Surround lists with blank lines
MD059 - Make link text descriptive
flashhax.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
gcsaves.md
MD059 - Make link text descriptive
get-started.md
MD026 - Remove trailing punctuation in heading
MD047 - End file with a newline
< The following will not be fixed due to certain exceptions >
MD060 - Forego table formatting due to size
hackmii.md
MD004 - Fix inconsistent unordered list style
MD022 - Surround headings with blank lines
MD032 - Surround lists with blank lines
hbc.md
MD004 - Fix inconsistent unordered list style
MD010 - Remove hard tabs
MD022 - Surround headings with blank lines
MD041 - Set top level heading for document
homebrew-dolphin.md
MD059 - Make link text descriptive
index.md
MD004 - Fix inconsistent unordered list style
key-information.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
legacy-exploits.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
< The following will not be fixed due to certain exceptions >
MD026 - Trailing punctuation not removed because of naming of an exploit
letterbomb.md
MD004 - Fix inconsistent unordered list style
mini-finalizing-setup.md
MD001 - Make headings increment by only one level
MD004 - Fix inconsistent unordered list style
modmii.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
MD060 - Make table formatting aligned
< The following will not be fixed due to certain exceptions >
MD060 - Forego table formatting on second table due to size
nintendont.md
< The following will not be fixed due to certain exceptions >
MD059 - Link text disregarded for redirect pages
nintendowfc.md
MD004 - Fix inconsistent unordered list style
MD059 - Make link text descriptive
osc.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
MD047 - End file with a newline
priiloader-usage.md
MD007 - Fix unordered list indentation
MD032 - Surround lists with blank lines
MD059 - Make link text descriptive
priiloader.md
MD007 - Fix unordered list indentation
MD009 - Remove trailing spaces
< The following will not be fixed due to certain exceptions >
MD060 - Forego table formatting due to size
recommended-homebrew.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
MD059 - Make link text descriptive
recovery-mode.md
MD004 - Fix inconsistent unordered list style
MD007 - Fix unordered list indentation
MD009 - Remove trailing spaces
riiconnect24.md
< The following will not be fixed due to certain exceptions >
MD059 - Link text disregarded for redirect pages
riitag.md
< The following will not be fixed due to certain exceptions >
MD059 - Link text disregarded for redirect pages
riivolution.md
< The following will not be fixed due to certain exceptions >
MD059 - Link text disregarded for redirect pages
rssmii.md
< The following will not be fixed due to certain exceptions >
MD059 - Link text disregarded for redirect pages
site-navigation.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
MD032 - Surround lists with blank lines
< The following will not be fixed due to certain exceptions >
MD036 - Emphasis kept for headings in info boxes for styling reasons
str2hax.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
syscheck.md
MD022 - Surround headings with blank lines
themes.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
transfer-saves.md
MD059 - Link text disregarded for redirect pages
vwii-finalizing-setup.md
MD009 - Remove trailing spaces
vwii-homebrew-channel.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
wii-factory-reset.md
MD004 - Fix inconsistent unordered list style
wii-loaders.md
MD004 - Fix inconsistent unordered list style
MD022 - Surround headings with blank lines
MD032 - Surround lists with blank lines
MD059 - Make link text descriptive
wiiconnect24.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
MD022 - Surround headings with blank lines
MD059 - Make link text descriptive
wiiu-nand-dumper.md
MD004 - Fix inconsistent unordered list style
MD009 - Remove trailing spaces
wilbrand.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
wnd-mini.md
MD004 - Fix inconsistent unordered list style
MD012 - Remove multiple consecutive blank lines
yawmme.md
MD004 - Fix inconsistent unordered list style
This is a DRAFT pull request and is awaiting the merge of other major pull requests to finish reviewing markdown. This pull request was originally transitioned from work made on #182, therefore it should be merged before this PR.