Skip to content

MgramTheDuck/materiaraiding

 
 

Repository files navigation

title layout nav_order permalink
About
about
2
/about

Materia Raiding Website

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

This Github Repository is for the Materia Raiding website, a Github Pages site built with Jekyll using the "Just the Docs" template. The goal is to create a comprehensive tool with all guides for current Savage and Ultimate content in one consistent open-source website.

As this website is built using an open-source github repository, anyone can contribute to the project with changes using the typical Github Pull-Request Workflow, please see the instructions below. Pull requests will be reviewed and merged by our team when submitted.

If you are not comfortable with editing content with github, you can join the conversation and suggest changes to us at the Materia Raiding Discord server.

Materia Raiding Discord

GitHub Pages Deployment

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.

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

{% include image.html path="https://github.com/materiaraiding/materiaraiding/assets/85346345/3bb113b8-bdd6-4463-b597-cb0e9be5227c" %}

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

{% include image.html path="https://github.com/materiaraiding/materiaraiding/assets/85346345/041b63df-2449-430c-8d91-07fbe0b9a442" %}

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

{% include image.html path="https://github.com/materiaraiding/materiaraiding/assets/85346345/fde900bb-48e3-4be0-8518-5c02d04b1fa7" %}

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

{% include image.html path="https://github.com/The-Seat-of-Namazu/namazu.tools/assets/85346345/ea33a705-6501-4a46-a6c8-155dc35e201c" %}

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

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

Further help

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 38.2%
  • CSS 31.7%
  • SCSS 27.5%
  • Ruby 2.6%