https://trac-bits-pilani.github.io/blog/
powered by fastpages
Hey! Thanks for showing up here. If you're here for writing articles, skip down to the next section. If you think you can help improve our design or want to fix some code, please do open a PR. Fastpages constantly update their original repository and we wouldn't want a broken link/dependency. Please do watch out for that if you wish to contribute.
Thanks again for showing interest in our work! We are open to article contributions. You can write an article in markdown, MS Word or with a Jupyter Notebook. For tutorials on how to present the format of each file, please refer to the links below.
Make sure to include the following in your header with the appropriate columns filled out. If you would like to include a cover image for your article to be displayed on our home page, add the image in the /images/blog_covers/ directory and link it in the markdown header. You can comment out the image line or delete it if you do not wish to have a cover image. The toc (table of contents based on your post headings) and comments option can also be set to true or false as per your wish.
---
title: "{A catchy title for your article}"
description: "{Description of the article}"
author: "{Authors}"
layout: post
toc: false
comments: true
image: images/blog_covers/{a cover image for your article (optional)}
search_exclude: false
categories: [{Any}, {Tags}]
---
If you are using any images in your article, please use the convention listed here. Images within the article must be placed inside a markdown table in exactly this format.
| |
|:--:|
| *A caption with a link to the source either here or in a footnote* |
When this is done, place the images inside /assets/blog/{article_number}_{underscore separated short title} (or link them directly from source if possible). Finally, name your file YYYY-MM-DD-*.md, with the date being the date in which you send your PR. Every word within the * must be hyphen separated. Place the file inside the /_posts/ directory and send in your PR, we'll review it as quick as we can and publish your article!
A Jupyter Notebook should also have a header like markdown articles. The first cell in your notebook should be a markdown cell with the following contents:
# {Title of the article}\n
> {Description}\n
- author: {Authors}\n
- toc: true\n
- badges: true\n
- comments: true\n
- image: images/blog_covers/{a cover image for your article (optional)}\n
- search_exclude: false\n
- categories: [{Any}, {Tags}]
Images within the article must also follow the same format as markdown. Again, name the file with the format YYYY-MM-DD-*.ipynb, with the same format as with markdown. When you're done with the eccentricities, please send in your PR, we'll publish your article after a review!
Please don't. If you do, here's a link to a markdown cheat sheet or use this blog post from fast.ai to do the necessary conversions. Word is not recommended because of configuration issues. We don't have a lot of control over the front matter of the article and it will be converted to markdown at some point during processing anyway. So please do consider writing in markdown directly.