This is not official, just discord server lore because I wanted to
For this, I just use a basic static html structure, using markdown files for the text content because I'm lazy XD
There are two ways you can contribute:
Before doing either, make sure it's a good idea, and reasonably sized. If it was between only two people, I won't accept it. *Around 5 or more is a decent size in my opinion*
* Subject to change with server size
Also, please don't just make events happen for the sole purpose of getting them on this page and you as credit. Doing that will highly reduce your chances of the event being accepted.
To contribute/request Events for this site, your first option is to do it manually via GitHub pull requests. Here's how:
- Create a fork (
Forkbutton at the top right). - Create a branch (
githubUsernamefollowed by your/pageName, or/eventName). You will be able to push to the master branch in your fork, but not in this main repository. In this branch, you can make the changes you want to make, either to existing pages/events or new pages/events; in which you should follow these steps:- OPTIONAL: Run
npm installin the root directory to install husky and prettier. This will just run prettier and set the environment config back to production (in case you forgot to) all automatically when you commit, AND set it back to development after the commit so you don't have to manually change it back. - Make sure you set
"environment" = "development"in theconfig.json - Adding a new event/page
- You need to create a new folder in the root directory called the name of your page. If you think your page belongs in a different parent folder, then create the folder in that parent folder instead.
- Inside that folder, you want to create 2 files. A
index.html, and apageName.md(Note that you don't NEED pageName.md, but if you are going to be having alot of body text, please add it for consistency and ease for me). - The
index.htmlshould be the same as the others (unless it needs to be different), so you can copy and paste that file if you want from another folder, just make sure to change theloadContent { fetch('url') }url.
- Editing an existing page
- You can go ahead and edit that page, MUST be on your
githubUsername/pageNamebranch. - The only rule behind this is that you CANNOT switch it to use full HTML; it must still used HTML and the markdown file.
- You can go ahead and edit that page, MUST be on your
- OPTIONAL: Run
- Commit and push your changes.
- Before opening a pull request, IF you didn't do step 2.i, make sure that in the
config.json, you set"environment" = "production". - Open a pull request. Vercel will deploy a testing website for your fork and you will be able to test it out and see it.
- Your pull request may be merged and changes will be deployed to the main site within a few minutes of the merge. You will be credited as the writer, IF I don't see fit to change much. IF I think only some parts need work, you will be credited as author and me and editor. Else, you'll be credited for handing me the event, but I will be the author.
- Happy coding :)
The second method you can do is just contacting me directly on Discord. This is straight forward. Just DM me about it and preferrably the link to one of the messages regarding the event so I can find it easier.