Broken Eye Studio's Logo
Home About Archive

So how do I wiki?

3 Methods

The Methods

  1. HTML from Template.

Prerequisites: Any IDE (VScode, Notepad++, etc.), Github Desktop + Brokeneye Wiki Access (Contact Chappy for access), and some time 👍.

This is pretty simple. All you really need to do is look at the template for new pages. You can follow this guide for html stuff, but you can pretty much figure everything out from the template and this cheatsheet.

Pssst, never used html before? Watch this! {#pssst,-never-used-html-before?-watch-this!}

Not convinced HTML is the way? Here’s some more info.
h1 is biggest, h2 is second biggest, h3 third, and so on. Italics is as easy as putting \\ (or even less coding \\)around the text. HTML is super simple like this and isn’t even technically a coding language. It stands for Hypertext Markup Language. Thats right, just like Markdown HTML is just a tool for defining formats for text.

Ok! I wrote my HTML! What now?

Now that your HTML is complete we need to add the header and footer to it. This allows consistency through the website adding things like the navigation bar (Shown below) and the credits.

So how do I add it? Just paste in this code at the top:

\<!DOCTYPE html> \ \ \ \ \
\ \Home\ \About\ \Archive\ \ \ \ \<!-- NOTE THAT THIS INCLUDES \, replace your own with this one. -->

And this code at the bottom:

\ \ \Thank You\ \ The wiki is possible thanks to the \Wiki Workers Team\. \ \

Now make sure your file is saved under /project-cyber/pages/your-page-title.html . Now we need to make it so your page is accessible by everyone. Open /Brokeneye-wiki/Project-Cyber/archive.html and fill out the information to add a link on archive.html to your new page!

An example of what archive.html should look like BEFORE adding your page/article.

\ \All Wiki Pages\ \<!-- Example New Page--> *\<!-- \\Example-Post-Title\ Last Edited 12/22/2024\ --→ \<!-- ADD NEW PAGES AT TOP HERE --→ \\Example-Post-Title\ Last Edited 12/22/2024\* \

So for example to create a link to template.html all I would need to do is copy the example new page line (\\Example-Post-Title\ | Last Edited 12/22/2024\) and change \ to \ then change Example-Post-Title to whatever you set the title of your post to. So in my example template would be the title of my post. The title is in-between the start \ tag and the end \ tag. After the \ tag there is the “Last Edited 12/22/2024” just simply change that to whatever the date you wrote/updated the article to. Right now its 12/22/2024 so thats currently accurate for me. After following this process my final link should look like: \\Template\ | Last Edited 12/22/2024\ .

An example of what archive.html should look like AFTER adding your page/article:

\ \All Wiki Pages\ \<!-- Example New Page--> *\<!-- \\Example-Post-Title\ Last Edited 12/22/2024\ ---> \<!-- ADD NEW PAGES AT TOP HERE -->* \\Template/a> Last Edited 12/22/2024\ \\Example-Post-Title\ Last Edited 12/22/2024\ \

  1. Markdown.

Prerequisites: Any Markdown compatible editor (Notion, Notepad++, StackEdit, etc.), Github Desktop + Brokeneye Wiki Access (Contact Chappy for access), and some time 👍.

While I CANNOT in good conscience say this is more beneficial than taking the 5 minutes to read about and learn HTML, it's not that far off and converts fairly simply into HTML. If you’re used to Markdown from Discord, Notion, or something else this may make more sense for you. Here's how to do it! Write the markdown however wherever you want BUT instead of doing images through however you would normally do it as outlined here and make sure they’re saved to Brokeneye-wiki/Project-Cyber/images. Once you’re done writing/formatting, convert it to HTML here. Then paste this at the start of what it converted:

\<!DOCTYPE html> \ \ \ \ \
\ \Home\ \About\ \Archive\ \ \

And then this at the end of what it converted:

\ \ \Thank You\ \ The wiki is possible thanks to the \Wiki Workers Team\. \ \

Now save it as page-name.html under Brokeneye-wiki/Project-Cyber/pages. Next open archive.html (Located in /Brokeneye-wiki/Project-Cyber/archive.html) and fill out the information to add a link on archive.html to your new page!

An example of what archive.html should look like BEFORE adding your page/article.

\ \All Wiki Pages\ \<!-- Example New Page--> *\<!-- \\Example-Post-Title\ Last Edited 12/22/2024\ --> \<!-- ADD NEW PAGES AT TOP HERE -->* \\Example-Post-Title\ Last Edited 12/22/2024\ \

So for example to create a link to template.html all I would need to do is copy the example new page line (\\Example-Post-Title\ | Last Edited 12/22/2024\) and change \ to \ then change Example-Post-Title to whatever you set the title of your post to. So in my example template would be the title of my post. The title is in-between the start \ tag and the end \ tag. After the \ tag there is the “Last Edited 12/22/2024” just simply change that to whatever the date you wrote/updated the article to. Right now its 12/22/2024 so thats currently accurate for me. After following this process my final link should look like: \\Template\ | Last Edited 12/22/2024\ .

An example of what archive.html should look like AFTER adding your page/article:

\ \All Wiki Pages\ \<!-- Example New Page--> *\<!-- \\Example-Post-Title\ Last Edited 12/22/2024\ ---> \<!-- ADD NEW PAGES AT TOP HERE -->* \\Template/a> Last Edited 12/22/2024\ \\Example-Post-Title\ Last Edited 12/22/2024\ \

###

  1. Google Docs.

DISCLAIMER: Doing it this way means you CANNOT delete the google doc at risk of breaking all of the images in the file and in some cases possibly the hyperlinks. This can be manually fixed by replacing the HTML links with storing the images and stuff on the Github repository.

This way is a little funky and you have to be very specific with it. It's entirely do-able, just not as fluid as the other options. Here’s how to do it:

  1. Write the page/article how you normally would in Google Docs, but make sure you use Header 1 for bigger titles and header 2 for 2nd biggest, etc. This will make sense when you convert it to HTML. Other than bold, italics, and some other stuff. FONTS AND STYLING WILL NOT CONVERT. In order to get a good example of how this translates, I wrote this article in Google Docs. You can find it here.
  2. Use this website to convert the doc to HTML. Just select the entire google doc, paste it into the website, and click .

  3. Make your-title.html (Replace your-title with the title of your page/article) and paste everything you copied from the converter into the file.

  4. Paste this before what it converted:

\<!DOCTYPE html> \ \ \ \ \
\ \Home\ \About\ \Archive\ \ \ \
  1. Paste this after what it converted:
\ \ \Thank You\ \ The wiki is possible thanks to the \Wiki Workers Team\. \ \
  1. Now save it as page-name.html (Replace page-name with your page name) under Brokeneye-wiki/Project-Cyber/pages.

  2. Next open archive.html (Located in /Brokeneye-wiki/Project-Cyber/archive.html) and fill out the information to add a link on archive.html to your new page!

    An example of what archive.html should look like BEFORE adding your page/article.

\ \All Wiki Pages\ \<!-- Example New Page--> *\<!-- \\Example-Post-Title\ Last Edited 12/22/2024\ --→ \<!-- ADD NEW PAGES AT TOP HERE --→ \\Example-Post-Title\ Last Edited 12/22/2024\* \

So for example to create a link to template.html all I would need to do is copy the example new page line (\\Example-Post-Title\ | Last Edited 12/22/2024\) and change \ to \ then change Example-Post-Title to whatever you set the title of your post to. So in my example template would be the title of my post. The title is in-between the start \ tag and the end \ tag. After the \ tag there is the “Last Edited 12/22/2024” just simply change that to whatever the date you wrote/updated the article to. Right now its 12/22/2024 so that's currently accurate for me. After following this process my final link should look like: \\Template\ | Last Edited 12/22/2024\ .

An example of what archive.html should look like AFTER adding your page/article:

\ \All Wiki Pages\ \<!-- Example New Page--> *\<!-- \\Example-Post-Title\ Last Edited 12/22/2024\ ---> \<!-- ADD NEW PAGES AT TOP HERE -->* \\Template/a> Last Edited 12/22/2024\ \\Example-Post-Title\ Last Edited 12/22/2024\ \

Now just commit to the Github Repository and you’re all done!