-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2177151
commit bc5d52a
Showing
3 changed files
with
43 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,36 @@ | ||
# blog | ||
Official blog for Cybersecurity Club, IITM. | ||
# How to Contribute | ||
|
||
For all practical purposes, all the content goes to `./content` folder. It contains the static markdown files that are converted to HTML | ||
|
||
Inside `content`, a new page can simply be created by creating a new `.md` file. They need to have a TOML header that goes in the following format. | ||
|
||
``` | ||
+++ | ||
+++ | ||
``` | ||
|
||
Even if the contents inside this is empty, the delimiters need to be there. | ||
|
||
Mostly try avoiding creating pages in the root folder (i.e. `content` folder). | ||
|
||
|
||
## Resources folder | ||
|
||
Rules follow as above. Title is necessary else the page is ignored. Despite it being sorted by title, the date is still necessary in the above format to show the publish date. | ||
|
||
Logic for the TOML follows from above. | ||
|
||
## Adding media | ||
|
||
To add an image, the following snippet suffices. | ||
|
||
`{{ img(id="/path/from/content/folder.png", alt="Alt Text", class="textCenter") }}` | ||
|
||
|
||
To add a youtube video, this one works | ||
|
||
`{{ youtube(id="The id of the video", class="textCenter") }}` | ||
|
||
To add a link to go to the top of the page, put this at the bottom. | ||
|
||
`{{ webring(webring="#", webringName="Go to the Top") }}` |