From 1cd962daf3d70c8ddb40f669ba33ebea119c605a Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Fri, 7 Apr 2017 19:05:13 +0200 Subject: [PATCH] Demo minima on GitHub Pages (#76) Merge pull request 76 --- .gitignore | 1 - README.md | 10 +++++----- Rakefile | 2 -- example/_config.yml => _config.yml | 2 +- .../_posts => _posts}/2016-05-20-my-example-post.md | 0 .../_posts => _posts}/2016-05-20-super-long-article.md | 0 ...05-20-this-post-demonstrates-post-content-styles.md | 0 .../_posts => _posts}/2016-05-20-welcome-to-jekyll.md | 0 example/about.md => about.md | 0 example/Gemfile | 4 ---- example/index.md => index.md | 0 script/build | 2 +- script/cibuild | 3 ++- 13 files changed, 9 insertions(+), 15 deletions(-) rename example/_config.yml => _config.yml (98%) rename {example/_posts => _posts}/2016-05-20-my-example-post.md (100%) rename {example/_posts => _posts}/2016-05-20-super-long-article.md (100%) rename {example/_posts => _posts}/2016-05-20-this-post-demonstrates-post-content-styles.md (100%) rename {example/_posts => _posts}/2016-05-20-welcome-to-jekyll.md (100%) rename example/about.md => about.md (100%) delete mode 100644 example/Gemfile rename example/index.md => index.md (100%) diff --git a/.gitignore b/.gitignore index 23e6075b57..a8c1c00ee8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .bundle .sass-cache Gemfile.lock -example/_site _site *.gem diff --git a/README.md b/README.md index 34fd15bc0e..c699ba2315 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. @@ -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. @@ -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 diff --git a/Rakefile b/Rakefile index 7124c5d763..c6a6ea4b97 100644 --- a/Rakefile +++ b/Rakefile @@ -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" diff --git a/example/_config.yml b/_config.yml similarity index 98% rename from example/_config.yml rename to _config.yml index aae30a4803..bbe58749bf 100644 --- a/example/_config.yml +++ b/_config.yml @@ -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 dribbble_username: dribbble diff --git a/example/_posts/2016-05-20-my-example-post.md b/_posts/2016-05-20-my-example-post.md similarity index 100% rename from example/_posts/2016-05-20-my-example-post.md rename to _posts/2016-05-20-my-example-post.md diff --git a/example/_posts/2016-05-20-super-long-article.md b/_posts/2016-05-20-super-long-article.md similarity index 100% rename from example/_posts/2016-05-20-super-long-article.md rename to _posts/2016-05-20-super-long-article.md diff --git a/example/_posts/2016-05-20-this-post-demonstrates-post-content-styles.md b/_posts/2016-05-20-this-post-demonstrates-post-content-styles.md similarity index 100% rename from example/_posts/2016-05-20-this-post-demonstrates-post-content-styles.md rename to _posts/2016-05-20-this-post-demonstrates-post-content-styles.md diff --git a/example/_posts/2016-05-20-welcome-to-jekyll.md b/_posts/2016-05-20-welcome-to-jekyll.md similarity index 100% rename from example/_posts/2016-05-20-welcome-to-jekyll.md rename to _posts/2016-05-20-welcome-to-jekyll.md diff --git a/example/about.md b/about.md similarity index 100% rename from example/about.md rename to about.md diff --git a/example/Gemfile b/example/Gemfile deleted file mode 100644 index 9e14c45d2a..0000000000 --- a/example/Gemfile +++ /dev/null @@ -1,4 +0,0 @@ -source "https://rubygems.org" - -gem "jekyll", "~> 3.3" -gem "minima", path: "../" diff --git a/example/index.md b/index.md similarity index 100% rename from example/index.md rename to index.md diff --git a/script/build b/script/build index c935a65eb7..c4ac84f875 100755 --- a/script/build +++ b/script/build @@ -3,4 +3,4 @@ set -e echo "Building the example site..." -bundle exec jekyll build --source example +bundle exec jekyll build diff --git a/script/cibuild b/script/cibuild index bfc34de159..c3c0e99295 100755 --- a/script/cibuild +++ b/script/cibuild @@ -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