53 lines
3 KiB
Markdown
53 lines
3 KiB
Markdown
---
|
|
title: "Structure"
|
|
permalink: /docs/structure/
|
|
excerpt: "How the theme is organized and what all of the files are for."
|
|
last_modified_at: 2018-01-03T12:03:59-05:00
|
|
---
|
|
|
|
Nothing clever here :wink:. Layouts, data files, and includes are all placed in their default locations. Stylesheets and scripts in `assets`, and a few development related files in the project's root directory.
|
|
|
|
**Please note:** If you installed Minimal Mistakes via the Ruby Gem method, theme files like `_layouts`, `_includes`, `_sass`, and `/assets/` will be missing. This is normal as they are bundled with the [`minimal-mistakes-jekyll`](https://rubygems.org/gems/minimal-mistakes-jekyll) Ruby gem.
|
|
{: .notice--info}
|
|
|
|
```bash
|
|
minimal-mistakes
|
|
├── _data # data files for customizing the theme
|
|
| ├── navigation.yml # main navigation links
|
|
| └── ui-text.yml # text used throughout the theme's UI
|
|
├── _includes
|
|
| ├── analytics-providers # snippets for analytics (Google and custom)
|
|
| ├── comments-providers # snippets for comments (Disqus, Facebook, Google+, and custom)
|
|
| ├── footer # custom snippets to add to site footer
|
|
| ├── head # custom snippets to add to site head
|
|
| ├── base_path # site.url + site.baseurl shortcut
|
|
| ├── feature_row # feature row helper
|
|
| ├── gallery # image gallery helper
|
|
| ├── group-by-array # group by array helper for archives
|
|
| ├── nav_list # navigation list helper
|
|
| ├── toc # table of contents helper
|
|
| └── ...
|
|
├── _layouts
|
|
| ├── archive-taxonomy.html # tag/category archive for Jekyll Archives plugin
|
|
| ├── archive.html # archive listing documents in an array
|
|
| ├── compress.html # compresses HTML in pure Liquid
|
|
| ├── default.html # base for all other layouts
|
|
| ├── home.html # home page
|
|
| ├── search.html # search page
|
|
| ├── single.html # single document (post/page/etc)
|
|
| └── splash.html # splash page
|
|
├── _sass # SCSS partials
|
|
├── assets
|
|
| ├── css
|
|
| | └── main.scss # main stylesheet, loads SCSS partials from _sass
|
|
| ├── images # image assets for posts/pages/collections/etc.
|
|
| ├── js
|
|
| | ├── plugins # jQuery plugins
|
|
| | ├── vendor # vendor scripts
|
|
| | ├── _main.js # plugin settings and other scripts to load after jQuery
|
|
| | └── main.min.js # optimized and concatenated script file loaded before </body>
|
|
├── _config.yml # site configuration
|
|
├── Gemfile # gem file dependencies
|
|
├── index.html # paginated home page showing recent posts
|
|
└── package.json # NPM build scripts
|
|
```
|