-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(config): add a namespace to the theme config map (#2)
- update readme - ensure normalize.css is included - fix padding on index article element
- Loading branch information
Showing
11 changed files
with
429 additions
and
46 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,18 +1,13 @@ | ||
| # jekyll-theme-guardian | ||
|
|
||
| Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`. | ||
|
|
||
| To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site! | ||
|
|
||
| TODO: Delete this and the text above, and describe your gem | ||
|
|
||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| Add this line to your Jekyll site's `Gemfile`: | ||
|
|
||
| ```ruby | ||
| gem "jekyll-theme-guardian" | ||
| gem "jekyll-theme-guardian", git: '[email protected]:widen/jekyll-theme-guardian.git', branch: "master" | ||
| ``` | ||
|
|
||
| And add this line to your Jekyll site's `_config.yml`: | ||
|
|
@@ -23,30 +18,61 @@ theme: jekyll-theme-guardian | |
| And then execute: | ||
| $ bundle | ||
| ```bash | ||
| $ bundle | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Or install it yourself as: | ||
| ### Configuration | ||
|
|
||
| $ gem install jekyll-theme-guardian | ||
| A number of configuration options are setup for use within your Jekyll site's `_config.yml`, all of the theme-specific options are prefixed with `guardian`: | ||
|
|
||
| ## Usage | ||
| ```yaml | ||
| guardian: | ||
| style: | ||
| logo_url: <URL> | ||
| header_background_url: <URL> | ||
| social_links: | ||
| twitter: <TWITTER_USERNAME> | ||
| github_org: <GITHUB_ORGANIZATION_NAME> | ||
| github_repo: <GITHUB_REPOSITORY_NAME> | ||
| tracking: | ||
| google_analytics_code: <GOOGLE_ANANLYTICS_CODE> | ||
| disqus_shortname: <DISQUS_SHORTNAME> | ||
| ``` | ||
| ### Layouts | ||
| * `default` - includes a header, content, and footer section | ||
| * `post` - extends `default` and optionally includes a Disqus comment block | ||
|
|
||
| ### includes | ||
|
|
||
| TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets. | ||
| * `head` - included on the `default` layout; specifies title, stylesheets, etc. | ||
| * `favicons` - sets up links to favicons for browsers and mobile devices | ||
| * `analytics` - if `site.guardian.tracking.google_analytics_code` is populated, this will include GA tracking code | ||
| * `header` - included on the `default` layout; renders the header with `site.guardian.style.logo_url` and `site.guardian.style.header_background_url` | ||
| * `footer` - included on the `default` layout; renders a footer with social links | ||
| * `git-info` - includes links to GitHub to view/edit content | ||
| * `disqus` - included on the `post` layout; if `site.guardian.tracking.disqus_shortname` is populated, this will include a Disqus comment block | ||
|
|
||
| ### Assets | ||
|
|
||
| * `app.css` - the main stylesheet; includes imported content from `_sass` as well as `normalize.css` | ||
| * `fonts` - the Ionicon font-family is included and wired for use | ||
| * `images` - a number of Widen-branded favicons are included in various sizes | ||
|
|
||
| ## Contributing | ||
|
|
||
| Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. | ||
| Bug reports and pull requests are welcome on GitHub at https://github.com/widen/jekyll-theme-guardian. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. | ||
|
|
||
| ## Development | ||
|
|
||
| To set up your environment to develop this theme, run `bundle install`. | ||
|
|
||
| Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. | ||
|
|
||
| When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled. | ||
| To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-guardian.gemspec` accordingly. | ||
|
|
||
| ## License | ||
|
|
||
| The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). | ||
|
|
||
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,8 +1,12 @@ | ||
| # theme configuration | ||
| logo_url: https://embed.widencdn.net/img/widen/c17yrvuaac/400px@2x/Widen Engineering White Logo.png?u=mcuc7i | ||
| header_background_url: https://embed.widencdn.net/img/widen/m4ml1kuspv/exact/1680x90_Engineering Blog Banner.png?keep=c&crop=yes&u=ksmgip | ||
| twitter_username: widendev | ||
| github_widen: https://github.com/widen | ||
| github_repository: https://github.com/widen/jekyll-theme-guardian | ||
| google_analytics_code: | ||
| disqus_shortname: | ||
| guardian: | ||
| style: | ||
| logo_url: https://embed.widencdn.net/img/widen/c17yrvuaac/400px@2x/Widen Engineering White Logo.png?u=mcuc7i | ||
| header_background_url: https://embed.widencdn.net/img/widen/m4ml1kuspv/exact/1680x90_Engineering Blog Banner.png?keep=c&crop=yes&u=ksmgip | ||
| social_links: | ||
| twitter: widendev | ||
| github_org: widen | ||
| github_repo: jekyll-theme-guardian | ||
| tracking: | ||
| google_analytics_code: | ||
| disqus_shortname: |
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
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
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
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
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
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,11 +1,15 @@ | ||
| .posts { | ||
| article { | ||
| margin-bottom: 30px; | ||
| } | ||
| ul { | ||
| padding-left: 0; | ||
| } | ||
|
|
||
| .posts-excerpt { | ||
| font-style: italic; | ||
| font-size: 1.65rem; | ||
| color: $dark-grey; | ||
| } | ||
| article { | ||
| margin-bottom: 30px; | ||
| } | ||
|
|
||
| .posts-excerpt { | ||
| font-style: italic; | ||
| font-size: 1.65rem; | ||
| color: $dark-grey; | ||
| } | ||
| } |
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
Oops, something went wrong.