Minimal Mistakes has been developed by Michael Rose for Jekyll. This is a port to use with 11ty. You can deploy it to Github Pages with Github Actions.

You can sponsor Michael Rose on the links below.

If you enjoy this theme, please consider sponsoring me to continue developing and maintaining it.

"Buy Me A Coffee"

Support via PayPal

Installing the theme

You clone this repository, and then you are ready to add your own spin to the template.

ProTip: Be sure to remove /docs and /test if you forked Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don’t want them littering up your repo.

NOT UPDATED FURTER

Looking for an example? Use the Minimal Mistakes remote theme starter for the quickest method of getting a GitHub Pages hosted site up and running. Generate a new repository from the starter, replace sample content with your own, and configure as needed.

Note: Your site should be viewable immediately at http://USERNAME.github.io. If it’s not, you can force a rebuild by Customizing Your Site (see below for more details).

If you’re hosting several sites under the same GitHub username you will have to use Project Pages instead of User Pages. Essentially you rename the repo to something other than USERNAME.github.io and create a gh-pages branch off of master. For more details on how to set things up check GitHub’s documentation.

creating a new branch on GitHub

You can also install the theme by copying all of the theme files[1] into your project.

To do so fork the Minimal Mistakes theme, then rename the repo to USERNAME.github.io — replacing USERNAME with your GitHub username.

fork Minimal Mistakes

Remove the Unnecessary

If you forked or downloaded the minimal-mistakes-11ty repo you can safely remove the following folders and files:

  • .editorconfig
  • .gitattributes
  • .github
  • /docs
  • /test
  • CHANGELOG.md
  • README.md
  • screenshot-layouts.png
  • screenshot.png

Setup Your Site

Depending on the path you took installing Minimal Mistakes you’ll setup things a little differently.

ProTip: The source code and content files for this site can be found in the /docs folder if you want to copy or learn from them.

Starting Fresh

Starting with an empty folder you need to copy the entire contents of the repository to get started.

For a full explanation of every setting be sure to read the Configuration section.

If you’re hosting on GitHub Pages, you can copy the _data/ui-text.yml file into your repository for the localization feature to work.

You’ll need to create and edit these data files to customize them:

Then you might want to clear out some of the stuff in the repository.

├── docs (clear out everything)

Note: When clearing out the assets folder be sure to leave any files you’ve added and need. This includes images, CSS, or JavaScript that aren’t already bundled in the theme.

That’s it! If all goes well the following should spin-up your site:

npm run watch:eleventy
npm run watch:sass

  1. See Structure page for a list of theme files and what they do. ↩︎