generated from mmistakes/mm-github-pages-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
31e6e9d
commit 1158786
Showing
1 changed file
with
28 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,36 @@ | ||
# Minimal Mistakes remote theme starter | ||
# userneedsmapping.com | ||
--- | ||
The website for User Needs Mapping | ||
|
||
## Development | ||
--- | ||
### Setup environment | ||
Install Docker Desktop on Windows: | ||
|
||
Click [**Use this template**](https://github.com/mmistakes/mm-github-pages-starter/generate) button above for the quickest method of getting started with the [Minimal Mistakes Jekyll theme](https://github.com/mmistakes/minimal-mistakes). | ||
``` | ||
\$ winget install -e --id Docker.DockerDesktop | ||
``` | ||
|
||
Contains basic configuration to get you a site with: | ||
Install Docker Desktop on MacOS: | ||
|
||
- Sample posts. | ||
- Sample top navigation. | ||
- Sample author sidebar with social links. | ||
- Sample footer links. | ||
- Paginated home page. | ||
- Archive pages for posts grouped by year, category, and tag. | ||
- Sample about page. | ||
- Sample 404 page. | ||
- Site wide search. | ||
``` | ||
\$ brew install --cask docker | ||
``` | ||
|
||
Replace sample content with your own and [configure as necessary](https://mmistakes.github.io/minimal-mistakes/docs/configuration/). | ||
### Day-to-day Development | ||
|
||
--- | ||
To run a server locally: | ||
``` | ||
\$ docker compose up | ||
``` | ||
|
||
## Troubleshooting | ||
Or open the project as a dev container and directly start the server: | ||
``` | ||
\$ bundle exec jekyll serve | ||
``` | ||
|
||
If you have a question about using Jekyll, start a discussion on the [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll). Other resources: | ||
Configuration | ||
The Minimal Mistakes skin was customized by copying the original main.scss file to assets\css. Any changes to the theme's Sass variables must be made before the any @importlines. | ||
|
||
- [Ruby 101](https://jekyllrb.com/docs/ruby-101/) | ||
- [Setting up a Jekyll site with GitHub Pages](https://jekyllrb.com/docs/github-pages/) | ||
- [Configuring GitHub Metadata](https://github.com/jekyll/github-metadata/blob/master/docs/configuration.md#configuration) to work properly when developing locally and avoid `No GitHub API authentication could be found. Some fields may be missing or have incorrect data.` warnings. | ||
License | ||
This work is licensed under a Creative Commons Attribution 4.0 International License. |