This page is designed to help members post write-ups using the Jekyll formatting mark-up. First things first. If you want to get started without going through the rest of this guide. Here is the quickstart helper:
After you have the repo cloned you will be able to navigate to the “_posts” directory where you can add individual write-ups and then push them to the github site. Try to maintain our current cleanliness and formatting/directory structure.
Blog pages that are used to create write-ups must be created in the “_posts” directory and must follow a specific format for the file name. Where
YEAR is a four-digit number,
DAY are both two-digit numbers, and
MARKUP is the file extension representing the format used in the file.
For example, the following are examples of valid post filenames:
The write-up blog must contain a header based on YAML Front Matter. In general each header should start out looking like the following:
Following the header, content formatting can be found here and . If you want to link to a specific image or file then you must upload it to the “_assets” directory. Additionally, if you are adding code blocks then there is also an option to enable syntax highlighting to make the code more readable.
When writing the solution begin with the location of where the challenge can be found if it’s an online challenge or soft links to where you uploaded them on this github site. After you’ve written this introduction paragraph make sure you add the
<!--break--> comment so the jekyll parsing engine can create a preview off your writeup.
Next, describe the steps you took to solve the challenge. This should include links where someone without your expertise can be able to find more if they want to research more. The general rule of thumb is that the reader should have knowledge of at least one high level programming language, a general concept of networking, and a general understanding of crypto.
Always stop to think after you are done writing - Will someone else be able to replicate what I saw when I solved this challenge?
We want to help someone understand not only the solution, but the what, how, and why you came to the solution you found. This will help develop the entire team.
After you are done creating the initial filename following our formatting template and creating the content inside your write-up file, push your update to the github repo. The only files that you need to commit should be the _posts folder. After you have committed your updates Jekyll will handle the rest!