https://github.com/noaaan/mythicwiki

The source code of the Mythic Metals Wiki
https://github.com/noaaan/mythicwiki

Last synced: 5 days ago
JSON representation

The source code of the Mythic Metals Wiki

• Host: GitHub
• URL: https://github.com/noaaan/mythicwiki
• Owner: Noaaan
• Created: 2023-03-04T21:04:43.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-22T21:58:15.000Z (16 days ago)
• Last Synced: 2024-12-22T22:25:18.291Z (16 days ago)
• Size: 5.83 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Mythic Metals Wiki

This repository contains the basis of what the Mythic Metals Wiki is going to be. The [theme used is the same as Wisp Forest, albeit with a handful of changes](https://github.com/Noaaan/mythic-docs-theme), and is also included as a submodule in case you want to serve the site locally.

This Wiki is heavily work-in-progress. There are many details to be ironed out, such as structure, contribution guidelines, and tools for exporting the data from Mythic Metals into a Wiki-friendly format. Maintenance on this will also be somewhat slow, since the main focus right now is to finish the current feature set of Mythic Metals before expensively documenting it. 

### Building and Cloning

If you only want to make small modifications that do no require actually building the site, clone like normal:

`git clone https://github.com/Noaaan/MythicWiki.git`

If you want to make larger contributions, you will have to clone recursively via SSH. This is due to the current setup of the theme requires SSH authentication, and to serve the site locally you need the theme as well.

`git clone [email protected]:Noaaan/MythicWiki.git --recursive`

For building against the theme you need to install MkDocs via Pip (Python). To get started simply run the following:

```bash

pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-video mkdocs-static-i18n[material]

```

To serve the documentation, go to the config directory of your desired language and run the serve command:

```bash

# cd config/[language of choice], E.G.:

cd config/en

mkdocs serve

```

Currently it is not possible to serve the full site with translations for all pages