File Structure
This is a basic file structure for Assist.
assist/
| includes/
| layouts/
| plugins/
| posts/
| img/
| assets/
| | js/
| | | bootstrap.min.js
| | | jquery.min.js
| | | main.js
| | | modalizer.js
| | | results.js
| | | search.js
| | | set-query.js
| | scss/
| | | bootstrap-overrides.scss
| | | custom-styling.scss
| | | fonts.scss
| | | mixins.scss
| | | post.scss
| | | variable.scss
| assets-dist/
| | js/
| | | bootstrap.min.js
| | | jquery.min.js
| | | all.min.js
| | css/
| | | bootstrap.min.css
| | | all.min.css
| | | print.css
| how-to/
| strategies/
| troubleshooting/
| wiki-images/
| index.html
| search.html
| 404.html
Our core folders consist of: includes/, layouts/, plugins/ and posts/.
The includes folder is used to hold small page fragments that you might want to use throughout your site. Ex: footer.html, header.html, sidebar.html, etc.
The layouts folder contains our site's layouts (aka templates).
The plugins folder contains any custom written plugins written in ruby.
This folder contains all of our posts. This will be the most used folder. Each post in this folder is a markdown file and should use the file extension ".md" or ".markdown". The naming convention of these files is very important and MUST follow the format: YEAR-MONTH-DAY-TITLE.md
An example post would be: 2016-03-16-sample-title-here.md
The images folder contains all images used in our articles. Each article will have it’s own image folder within this folder. When creating a new post make sure the image folder name and the article itself are the same.
For example, if I were to write an article titled, 2016-03-16-sample-title-here.md the image folder for this article would be named 2016-03-16-sample-title-here.
Naming each individual image is just done by giving using the word “image” followed by the number of the step within the sequence the image is for.
For example, the first image in the 2016-03-16-sample-title-here.md post would be: image00.png
You’ll eventually end up with something like this.
The wiki-images folder contains all the images used in the Wiki.
Each category in Assist is a folder containing the category's page. Assist only has 3 categories (How-to, Strategies, and Troubleshooting) and therefore only needs 3 folders, each with its own index.html inside.
The assets folder contains our SOURCE styling and scripts. These are the actual files that a developer will be modifying. These files will be compiled and generate into the distribution assets.
For a more detailed explanation of a Jekyll file structure, you may want to checkout Jekyll’s documentation on the directory structure.
The assets folder contains our styling and scripts. These files are not modified or touched. They are only generated from assets/.