Skip to content

Commit

Permalink
Demo minima on GitHub Pages (jekyll#76)
Browse files Browse the repository at this point in the history
Merge pull request 76
  • Loading branch information
DirtyF authored and jekyllbot committed Apr 7, 2017
1 parent 30208d9 commit a4726e6
Show file tree
Hide file tree
Showing 13 changed files with 9 additions and 15 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.bundle
.sass-cache
Gemfile.lock
example/_site
_site
*.gem
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ And then execute:
## Contents At-A-Glance
Minima has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.
Minima has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.

### Layouts

Expand All @@ -47,9 +47,9 @@ Refers to snippets of code within the `_includes` directory that can be inserted
- `header.html` — Defines the site's main header section.
- `icon-* files` — Inserts github and twitter ids with respective icons.

### Sass
### Sass

Refers to `.scss` files within the `_sass` directory that define the theme's styles.
Refers to `.scss` files within the `_sass` directory that define the theme's styles.

- `minima.scss` — The core file imported by preprocessed `main.scss`, it defines the variable defaults for the theme and also further imports sass partials to supplement itself.
- `minima/_base.scss` — Resets and defines base styles for various HTML elements.
Expand All @@ -58,7 +58,7 @@ Refers to `.scss` files within the `_sass` directory that define the theme's sty

### Assets

Refers to various asset files within the `assets` directory.
Refers to various asset files within the `assets` directory.
Contains the `main.scss` that imports sass files from within the `_sass` directory. This `main.scss` is what gets processed into the theme's main stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.

This directory can include sub-directories to manage assets of similar type, and will be copied over as is, to the final transformed site directory.
Expand Down Expand Up @@ -138,7 +138,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll

To set up your environment to develop this theme, run `bundle install`.

To test your theme, run `bundle exec rake preview` and open your browser at `http://localhost:4000/minima/`. This starts a Jekyll server using your theme and the contents of the `example/` directory. As you make modifications to your theme and to the example site, your site will regenerate and you should see the changes in the browser after a refresh.
To test your theme, run `bundle exec rake preview` and open your browser at `http://localhost:4000/minima/`. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.

## License

Expand Down
2 changes: 0 additions & 2 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ end
task :preview do
base = Pathname.new('.').expand_path
options = {
"source" => base.join('example').to_s,
"destination" => base.join('example/_site').to_s,
"force_polling" => false,
"serving" => true,
"theme" => "minima"
Expand Down
2 changes: 1 addition & 1 deletion example/_config.yml → _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: > # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
baseurl: "/minima"
twitter_username: jekyllrb
github_username: jekyll

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 0 additions & 4 deletions example/Gemfile

This file was deleted.

File renamed without changes.
2 changes: 1 addition & 1 deletion script/build
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
set -e

echo "Building the example site..."
bundle exec jekyll build --source example
bundle exec jekyll build
3 changes: 2 additions & 1 deletion script/cibuild
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ script/build
if test -e "./_site/index.html";then
echo "It builds!"
rm -Rf _site
exit 0
else
echo "Huh. That's odd. The example site doesn't seem to build."
exit 1
fi

gem build minima.gemspec

0 comments on commit a4726e6

Please sign in to comment.