To view the cheat sheet click here.
This checklist was created by adopting the source code from the Dark Souls 3 Cheat Sheet created by ZKjellberg.
The walkthrough is thanks to Athrek.
If you are interested in contributing to this guide, please do so. Follow this step by step guide and reach out to me on discord if you have any questions Azy#9592
- Make a github account.
- Click "Issues" and check if an issue describing what you want is already open.
- If there isn't one. Create a new issue and click "Assign to self" so other people know what you are working on.
- Download and install Github Desktop and then sign in with your github account.
- Then you will need to fork this project. That will create your own project that you download and make changes to. Later you'll submit a request to bring those changes back here and onto the website. To fork this project click the fork button on the top right of the page.
- All information for the website is stored in
data
. Each.yaml
file is a different page. You can either add to existing files are create a new one. Don't editindex.html
as that is automatically generated based off of the stuff indata
. The data has to be in a specific format:
Each page of the site starts like this:
title: "Weapons"
id: weapons
sections:
Eeach section on a page starts like this:
-
title: "Daggers"
id: daggers
link: "https://eldenring.wiki.fextralife.com/Daggers"
num: 1
items:
- [1, "Dagger"]
- [3, "You can embed links like this: <a href=\"https://eldenring.wiki.fextralife.com/Black+Knife\"Black Knife</a>"]
- "You can put arbitrary text inbetween the checklists like this"
- [4, "You can put any html in here, <b>Bold!</b>, <i>Italic</i>, etc."]
-
title: "Table example"
id: table_example
num: 2
table: ["Column 1", "Column 2", "Column 3"] # If you don't want the table to have headers put "table: 3" instead where 3 is the number of columns
items:
- [1, "Include a string for each column", "This is going in the second column", "And this the third"]
All ids have to be unique and the num:
field also has to be unique. Within an item the first number has to be uinque as well. If you are adding a new line find the biggest number in that section and increase it by 1. The numbers do not have to be in order and you should not ever change an existing number because it will break everyones saved progress.
If you added a new page you need to put your page in pages.yaml
for it to show up.
- Once you are done with your changes double click
generate.bat
to see what it will look like. This requires you to have python3 installed. - If you are happy with it open github desktop and describe what you added in the bottom left where there is a text box labeled "Description".
- Push the button in the bottom left that says "Commit to gh-pages"
- Push the button in the top right that says "Push origin"
- Go to Branch -> Create Pull Request
- In the webpage that opens describe your changes and why you want them published to the website
- Hit create pull request
- I will look them over and add them to the website if they are good.
- Thanks for contributing!