This README will give you important info on how to add your posts to the CSC Blog! First off, here are all the branches websites available to you right now! Just click on the one you're interested in and you'll be able to follow along and add your post!
Contributing to the Pitt CSC Blog is very simple. All you have to do is create a markdown file (more on this later) and submit a pull requst, basically asking for it to be added to the website.
The markdown file you submit has to follow a certain format, nothing too weird or complex, just a little pre-formatting. Here's a short sample post, in markdown and rendered:
---
title: How to Animate Your Website With GSAP
author: Alexander Grattan
tags: ["web dev"]
date: 2021-12-19
---
Paragraphs are separated by a blank line.
2nd paragraph. _Italic_, **bold**, and `monospace`. Itemized lists
look like:
- this one
- that one
- the other one
Note that --- not considering the asterisk --- the actual text
content starts at 4-columns in. |
|
The pre-formatting mentioned before consists of assigning each post a title and an author. These will be used to identify the post and help with backend formatting. After the second set of ---you may begin writing your post. We'll leave a few sample lines of code as well as resources below that should help with writing your markdown files.
<!-- text -->
text is written on the file, no special tags or funky stuff.
markdown does have whitespace rules, which we'll link below!
# H1 Heading -> this is the largest type of heading assignable
<!-- unordered lists -->
- element 1
- element 2
- element 3
<!-- ordered lists -->
1. element 1
2. element 2
3. element 3Here are some links we found very helpful ourselves:
The easiest way to submit a post is through GitHub by heading over to the branch repository and following these steps:
Just head over to the repositories landing page and navigate to the src/posts folder and click on Add file and then Create new file.
The second step requires you to add a title to your post, which ideally corresponds to the title of the post, the pre formatting, and the post body
- file name (title)
- pre formatting
- post body
For step 3 you will scroll down to the bottom of the page and:
- add the file name to the first box
- add
byand then the author name in the second box - name the pull request as
new-<title>-<author>(title has no file extension!)
After that click Propose new file
The next step is simple, just click on Create pull request and you're done!
The easiest way to accpet a post is through GitHub by heading over to the branch repository and following these steps:
Head over to the pull requests tab and identify the post you want to accept. Click on it to open the pull request.
After opening the pull requests you can click on Commits to view the post. There should be only one commit and once you click on it the post will be visible. After reviewing it head to the next step.
After review scroll down to the bottom of the page and click Merge pull request.
Confirm the pull request
and delete the branch.
If you want to contribute, head over to the CONTRIBUTING documentation to see how to add or suggest features to the blog!