From ea61589b12768bc1403cbf37fd69fc05760d232f Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 10:48:35 -0400 Subject: [PATCH 1/7] Add travis yaml --- .travis.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..e9519db --- /dev/null +++ b/.travis.yml @@ -0,0 +1,9 @@ +language: ruby +rvm: + - 2.3.0 + +install: + - bundle install + +script: + - bundle exec jekyll build From 62fc067441b4e7e382155010d708d4a7902e5564 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 10:53:03 -0400 Subject: [PATCH 2/7] Update .travis.yml --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index e9519db..60b3da7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,4 +6,5 @@ install: - bundle install script: + - npm run test - bundle exec jekyll build From 9d51b4601c060ecf73bc9c60b00ee3a5bbf848e1 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 10:53:28 -0400 Subject: [PATCH 3/7] Update .travis.yml --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 60b3da7..36e92e8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,7 @@ rvm: - 2.3.0 install: + - npm install - bundle install script: From 6d14c454f1bbfa0c54e5e248cd5233eaffab1256 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 10:54:17 -0400 Subject: [PATCH 4/7] Update package.json --- package.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index c4ade3e..de44ef9 100644 --- a/package.json +++ b/package.json @@ -10,5 +10,8 @@ "stylelint": "^7.9.0", "stylelint-config-primer": "^1.4.0" }, - "dependencies": {} + "dependencies": {}, + "scripts": { + "test": "stylelint '**/*.scss'" + } } From d554236ba30acb44d1c8c19973d83ed94a1e687d Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 11:00:40 -0400 Subject: [PATCH 5/7] Update .travis.yml --- .travis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.travis.yml b/.travis.yml index 36e92e8..c7ec1c3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,8 @@ language: ruby rvm: - 2.3.0 +env: + - TRAVIS_NODE_VERSION="9.3.0" install: - npm install From 6a6efba27ac37e8b202040363296151c839cbcea Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 11:17:10 -0400 Subject: [PATCH 6/7] fix linting / rules --- .stylelintrc.json | 3 +++ _sass/labels.scss | 2 +- _sass/layout.scss | 2 ++ _sass/navigation.scss | 3 +-- _sass/support/mixins/_layout.scss | 10 ++++++---- 5 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.stylelintrc.json b/.stylelintrc.json index 19028f9..a624c10 100644 --- a/.stylelintrc.json +++ b/.stylelintrc.json @@ -1,4 +1,7 @@ { + "ignoreFiles" : [ + "assets/css/just-the-docs.scss" + ], "extends": [ "stylelint-config-primer" ] diff --git a/_sass/labels.scss b/_sass/labels.scss index a15d40c..23cc510 100644 --- a/_sass/labels.scss +++ b/_sass/labels.scss @@ -12,9 +12,9 @@ margin-right: $sp-1; margin-left: $sp-1; color: $white; + text-transform: uppercase; vertical-align: middle; background-color: $blue-100; - text-transform: uppercase; @include fs-2; } diff --git a/_sass/layout.scss b/_sass/layout.scss index 9bb6889..e3c93e4 100644 --- a/_sass/layout.scss +++ b/_sass/layout.scss @@ -115,6 +115,7 @@ } } +// stylelint-disable selector-no-type body { position: relative; padding-bottom: $sp-10; @@ -124,6 +125,7 @@ body { padding-bottom: 0; } } +// stylelint-enable selector-no-type .site-footer { position: absolute; diff --git a/_sass/navigation.scss b/_sass/navigation.scss index e6f1d22..802a6ed 100644 --- a/_sass/navigation.scss +++ b/_sass/navigation.scss @@ -11,9 +11,9 @@ position: absolute; top: 0; right: 0; + z-index: 101; height: 60px; padding-top: $sp-4; - z-index: 101; box-shadow: inset 0 -1px 0 $border-color; } } @@ -89,7 +89,6 @@ } } - .navigation-list-toggle { position: absolute; right: $sp-4; diff --git a/_sass/support/mixins/_layout.scss b/_sass/support/mixins/_layout.scss index 52b9e3c..7e7967e 100644 --- a/_sass/support/mixins/_layout.scss +++ b/_sass/support/mixins/_layout.scss @@ -15,20 +15,22 @@ @media (min-width: rem($value)) { @content; } - } @else { + } + + @else { @warn "No value could be retrieved from `#{$media-query}`. " - + "Please make sure it is defined in `$media-queries` map."; + + "Please make sure it is defined in `$media-queries` map."; } } // Responsive container @mixin container { - padding-left: $gutter-spacing-sm; padding-right: $gutter-spacing-sm; + padding-left: $gutter-spacing-sm; @include mq(md) { - padding-left: $gutter-spacing; padding-right: $gutter-spacing; + padding-left: $gutter-spacing; } } From 6400e79e022961f3b3a2751f0de8f5c305e4941f Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 11:22:11 -0400 Subject: [PATCH 7/7] Update README.md --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3df45b1..7e2181d 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,13 @@ Or install it yourself as: Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. 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. +### Submitting code changes: + +- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls) +- Ensure all CI tests pass +- Await code review +- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/). + ## Development To set up your environment to develop this theme, run `bundle install`. @@ -43,16 +50,6 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released. - -### When your changes are ready: - -- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls) -- Await code review -- Bump the version number in `just-the-docs.gemspec` -- Run `script/build` to package the gem -- Run `gem push just-the-docs-.gem` to publish the gem to Rubygems.org - ## License The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). -