Skip to content

The Reloaded MkDocs Theme



A Theme for MkDocs Material. (Version 1.0.0)
That resembles the look of Reloaded.

About

This it the NexusMods theme for Material-MkDocs, inspired by the look of Reloaded-II.

The overall wiki theme should look fairly close to the actual launcher appearance.

Quick Setup

  • Copy the copy-me folder contents to your repository root (skip .gitignore if you already have one)
  • Push to GitHub, this should produce a GitHub Pages site.

Your page should then be live.

Directory Structure

The theme assets are organized under the vendor/Reloaded/ directory:

docs/
├── vendor/
│   └── Reloaded/
│       ├── Images/          # Theme icons and images
│       └── Stylesheets/     # Theme CSS files
├── index.md
└── ... (your documentation)

This structure keeps all Reloaded theme assets organized and separate from your content.

Tip

Refer to Contributing for instructions on how to locally edit and modify the wiki.

Note

For Reloaded3 theme use reloaded3-slate instead of reloaded-slate.

Note

If you run into issues deploying, make sure Settings->Pages has Build and Deployment source set as GitHub Actions.

Extra

Info

Most documentation pages will also include additional plugins; some which are used in the pages here. Here is a sample complete mkdocs.yml you can copy to your project for reference.

Technical Questions

If you have questions/bug reports/etc. feel free to Open an Issue.

Happy Documenting ❤️