65linesofcode / materiaraiding

Materia Raiding

Materia Raiding is a community driven project to collate the various guides and tools created for raiding in the FF14 Materia Datacenter.

This Repo is for the Materia Raiding website, a Github Pages site built with Jekyll using the "Just the Docs" template. You can find the website here: Materia Raiding Website

The goal is to create a comprehensive tool with all guides for current Savage and Ultimate content in one consistent open-source website.

How to Contribute

Make a Fork of the project and do your edits in the fork, you can then create a Pull Request to merge your edits back into the main repository.

First, login to github, you need an account to make changes.

1. Make a Fork using the Fork Button on the Materia Raiding Repo Page (fork is like your own copy of the website)

2. Make Changes on your Fork, edit files and commit the changes to your Fork. You can edit the files directly in the web browser with the Edit Button. Then "Commit Changes" to save them to your fork.

3. When you have completed your changes, use the "Contribute" button on your Fork Page to create a Pull Request, this submits it back to the main repo for us to approve the changes.

4. Once your pull request is approved, your changes will appear on the website. It will take 5-10 mins for the system to render the new changes.

If you get stuck, reach out to "mgram" in MR or MUR Discords.

Pages

Each page is a single Markdown File (.md) which can be located anywhere in the root folder. Each page begins with a header to specify the page name and details, this will not appear in the final page.

After this, you can use Markdown or HTML formatting to build out the page. Take a look at some of the existing pages for an example.

[Here is some reference guides for the different types of formatting you can use:

Markdown Cheatsheet](https://www.markdownguide.org/cheat-sheet/)

This website uses Just-The-Docs, a website generating Jekyll theme that can create special custom components using simple tags inside the page. You can read more about how these work with the link below. Just-The-Docs Documentation

Glossary

A custom glossary add-in allows creating mouse-over tooltips that can be inserted into documents. These must be pre-defined in the ./_data/glossary.yml file.

- term: Thunderstruck
  definition: Two players are targeted with the Thunderstruck debuff and need to stay away from the party to avoid killing party members or giving them paralysis.

Once definded, these can be inserted into the page using the following tag.

{% glossary <term> %}

for example...

{% glossary Thunderstruck %}

Which will create a tooltip like so...

Further help

If your interested with helping on this project, you can get involved and join the discussion in the Materia Raiding Discord