hacks-guide-minimal-mistake.../_docs/02-structure.md

57 lines
2.9 KiB
Markdown
Raw Normal View History

2016-04-04 22:36:26 +02:00
---
title: "Structure"
permalink: /docs/structure/
2016-04-14 15:20:44 +02:00
excerpt: "How the theme is organized and what all of the files are for."
2016-04-04 22:36:26 +02:00
sidebar:
2016-04-06 03:50:10 +02:00
title: "v3.0"
2016-04-04 22:36:26 +02:00
nav: docs
2016-04-13 23:10:01 +02:00
modified: 2016-04-13T15:54:02-04:00
2016-04-04 22:36:26 +02:00
---
2016-04-13 23:10:01 +02: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.
2016-04-04 22:36:26 +02:00
```bash
minimal-mistakes
2016-04-05 03:16:25 +02:00
├── _data # data files for customizing the theme
| ├── navigations.yml # main navigation links
2016-04-13 23:10:01 +02:00
| └── ui-text.yml # text used throughout the theme's UI
2016-04-04 22:36:26 +02:00
├── _includes
2016-04-05 03:16:25 +02:00
| ├── 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
2016-04-13 23:10:01 +02:00
| ├── group-by-array # group by array helper for archives
2016-04-05 03:16:25 +02:00
| ├── nav_list # navigation list helper
2016-04-13 23:10:01 +02:00
| ├── toc # table of contents helper
2016-04-04 22:36:26 +02:00
| └── ...
├── _layouts
2016-04-05 03:16:25 +02:00
| ├── 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
| ├── single.html # single document (post/page/etc)
| └── splash.html # splash page
2016-04-04 22:36:26 +02:00
├── assets
2016-04-13 23:10:01 +02:00
| ├── _scss # stylesheet source files
2016-04-05 03:16:25 +02:00
| | ├── vendor # vendor SCSS partials
2016-04-13 23:10:01 +02:00
| | ├── main.scss # imports all SCSS partials
| | └── ... # theme SCSS partials
2016-04-04 22:36:26 +02:00
| ├── css
2016-04-13 23:10:01 +02:00
| | └── main.css # optimized stylesheet loaded in <head>
2016-04-04 22:36:26 +02:00
| ├── fonts
2016-04-05 03:16:25 +02:00
| | └── fontawesome-webfont # Font Awesome webfonts
2016-04-04 22:36:26 +02:00
| ├── js
2016-04-05 03:16:25 +02:00
| | ├── plugins # jQuery plugins
| | ├── vendor # vendor scripts
2016-04-13 23:10:01 +02:00
| | ├── _main.js # plugin settings and other scripts to load after jQuery
| | └── main.min.js # optimized and concatenated script file loaded before </body>
2016-04-05 03:16:25 +02:00
├── images # image assets for posts/pages/collections/etc.
├── _config.yml # site configuration
├── Gemfile # gem file dependencies
├── Gemfile.lock # gem file dependencies
├── index.html # paginated home page showing recent posts
└── package.json # NPM build scripts
2016-04-04 22:36:26 +02:00
```