README.md

How to update the Issie website

The content of each page is in its markdown (.md) file:
1. index.md (Home Page)
2. userGuide.md
3. verilogComp.md
4. coolFeatures.md
5. contact.md
By changing the markdown and pushing to github the website will update automatically
The images used in the above .md files are placed in the img folder.
To put table of contents in a page insert this in your .md file where you want the TOC to be:
```
- TOC
{:toc}
```
If you don't want a header to be included in the TOC add {:.no_toc} below the header
- Example
```
## My Header
{:.no_toc}
```
The content of Key Features in the Home Page is built using the carousel.html in the _includes directory
- You can add a new feature using the following syntax:
```
- [image: "path/to/image.png", 
      description: "{YOUR DESCRIPTION}", 
      title: "{YOUR TITLE}"]
```
- See existing code in the header of index.md for how to use this include.
The ISSIE description (What is ISSIE in the home page) is in the description.html in the _includes directory and is the only section written in pure HTML in order to be included in the home page before key features.

To add a new blog post:
- Add a new file with the format YYYY-MM-DD-name-with-dashes.md in the _posts folder
- Add the necessary information at the header:
  - ---
  - layout: post
  - title: "{YOUR TITLE}"
  - date: {YYYY-MM-DD HH:MM:SS +TIMEZONE}
  - categories: Issie Blog
  - ---
- Add the content of the post below the header
- Check this file for reference
- Let Pagination do its magic
- WARNING: If your date and time refer to the future, the post will not appear on the Blog page!
To change number of posts per page in the main blog page:
- Change paginate: 3 to the number you like in _config.yml

The 4 layouts used: home.html (for home page), page.html (for other pages), blog.html and post.html are all in the _layouts folder.
Images used in layouts are in the images folder