diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000000..8100a1d215e --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,18 @@ +{ + "MD003": { "style": "atx" }, + "MD004": { "style": "asterisk"}, + "MD007": { "indent": 4 }, + "MD013": false, + "MD024": { "siblings_only": true }, + "MD029": { "style": "one" }, + "MD033": { "allowed_elements": ["br"], "table_allowed_elements": ["hr", "br", "ul", "li"]}, + "MD035": { "style": "---" }, + "MD040": false, + "MD045": false, + "MD046": { "style": "fenced" }, + "MD048": { "style": "backtick" }, + "MD049": { "style": "asterisk" }, + "MD050": { "style": "asterisk" }, + "MD055": { "style": "leading_and_trailing" }, + "MD060": { "style": "aligned" } +} \ No newline at end of file diff --git a/README.md b/README.md index e03908fb4eb..334f7fefd43 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,18 @@ The complete guide to modding your Wii, vWii, and Wii mini. -https://wii.hacks.guide/ +[![Website Badge](https://img.shields.io/badge/website-wii.hacks.guide-21ABDE?logo=vitepress&logoColor=FFFFFF)](https://wii.hacks.guide/) +[![Translation Badge](https://img.shields.io/badge/translation-contribute-263238?logo=crowdin&logoColor=FFFFFF)](https://hacks-guide.crowdin.com/u/projects/12) +[![Discord Server](https://img.shields.io/badge/chat-nintendo%20homebrew-7289DA?logo=discord&logoColor=FFFFFF)](https://discord.gg/C29hYvh) +[![Last Commit Badge](https://img.shields.io/github/last-commit/hacks-guide/Guide_Wii)](https://github.com/hacks-guide/Guide_Wii/commits/master/) +![Language Count](https://img.shields.io/badge/languages-3-brightgreen) +[![MIT License](https://img.shields.io/badge/license-MIT-A31F34)](https://github.com/hacks-guide/Guide_Wii/blob/master/LICENSE.txt) ## Running the site locally This requires the following installed on your system: -- node.js + +* node.js To test the website locally, clone the source code: @@ -23,4 +29,48 @@ npm ci npm run docs:dev ``` -The website should now be running on http://127.0.0.1:5173/ (or a port shown on the terminal). +The website should now be running on (or a port shown on the terminal). + +If you choose to run multiple web servers at once, they will begin running at the next highest usable port (e.g. :5174, :5175, and so on). + +## Markdown Styling + +When making contributions to the guide, it is optimal to be aware of the project's preferred Markdown formatting, so that documentation formatting can be consistent. + +### Headings + +* ATX style `#` headings should be used. +* The same heading name can only be repeatedly used on headings with different parents. + +### Unordered Lists + +* Unordered lists should be created with the asterisk symbol `*` for consistency. +* Unordered lists should be indented with four spaces, or a single press of `TAB` in an accordingly configured code editor. + +### Ordered Lists + +* Ordered lists should be created using the number one `1.` for consistency. + +### HTML Elements + +* The HTML elements `
`, `
`, `