To post scribe notes, go to the _posts
folder and create a pull request.
This can easily be done from the browser by going to the _posts folder and clicking Create new file
in the upper right.
-
Name your file
YYYY-MM-DD-title.md
for example2017-02-15-RSA.md
-
Write your notes in github flavored markdown. See this cheetsheet.
-
Include at the top of the file the following front matter:
--- layout: notes title: RSA Security scribe: Your Name --- Notes go here...
-
When you're done write a commit message and click
Propose new file
-
Click "Creat Pull Request", and the TAs will review and approve it.
-
Drop a star for your favorite TA 😎
See an example here
Inline images can be easily included
Instructions:
- Upload image to
img/
folder - Reference image in markdown
![alt text]({{ site.url }}/img/name_of_img.jpg "Title")
If you want to preview your notes locally you'll need to install jekyll. Then, just run:
jekyll serve
You will also need to install ruby version >= 2.0.0 and any dependencies that come up.
Then, from the main directory of the repository, just run:
bundle exec jekyll serve
It will tell you which address to go to in your browser to preview the page (default is http://localhost:4000).