wii.hacks.guide

The complete guide to modding your Wii, vWii, and Wii mini.

Running the site locally

This requires the following installed on your system:

• node.js

To test the website locally, clone the source code:

git clone https://github.com/hacks-guide/Guide_Wii --recurse-submodules
cd Guide_Wii

Then simply run the following commands:

npm ci
npm run docs:dev

Tip

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).

The website should now be running on http://127.0.0.1:5173/ (or whatever port is shown on the terminal).

Markdown Styling

Important

When contributing to the project, try to keep your Markdown in line with the below described styling rules. This helps keep documentation consistent and clean.

This is especially important if you are planning to make significant edits or create a new guide page.

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 <hr>, <br>, <ul>, and <li>, can only be used in GitHub style tables.
• The HTML element <br> can only be used outside of GitHub style tables as a workaround for line breaks after headings.

Horizontal Rules

• Horizontal rules should only be created using triple hyphens ---.

Code Blocks

• Code blocks should only be created in a fenced style.
• Code blocks should be created with the backtick symbol ```.

Text Formatting

• Emphasis should be specified with the asterisk symbol *.
• Boldness, or strong, should be specified with the asterisk symbol **.

Tables

• Tables should be created with leading and trailing pipes |.
• Tables should be constructed in an aligned style whenever possible.