diff --git a/.scss-lint.yml b/.scss-lint.yml deleted file mode 100644 index dce0f15e2d..0000000000 --- a/.scss-lint.yml +++ /dev/null @@ -1,354 +0,0 @@ -# This is the lint file for .scss files. It uses https://github.com/causes/scss-lint -# to search through .scss files and point out errors. -# You can view these errors in your editor. -# -# Here's a link to all the default configurations -# https://github.com/causes/scss-lint/blob/master/config/default.yml -# below is our settings. - -linters: - BangFormat: - enabled: true - space_before_bang: true - space_after_bang: false - - BorderZero: - enabled: true - convention: zero # or `none` - - ColorKeyword: - enabled: true - - ColorVariable: - enabled: false - - Comment: - enabled: false - - DebugStatement: - enabled: true - - DeclarationOrder: - enabled: true - - DuplicateProperty: - enabled: true - - ElsePlacement: - enabled: true - style: same_line # or 'new_line' - - EmptyLineBetweenBlocks: - enabled: true - ignore_single_line_blocks: true - - EmptyRule: - enabled: false - - FinalNewline: - enabled: true - present: true - - HexLength: - enabled: true - style: short # or 'long' - - HexNotation: - enabled: true - style: lowercase # or 'uppercase' - - HexValidation: - enabled: true - - IdSelector: - enabled: true - - ImportantRule: - enabled: true - - ImportPath: - enabled: true - leading_underscore: false - filename_extension: false - - Indentation: - enabled: true - allow_non_nested_indentation: false - character: space # or 'tab' - width: 2 - - LeadingZero: - enabled: true - style: include_zero - - MergeableSelector: - enabled: true - force_nesting: true - - NameFormat: - enabled: false - convention: hyphenated_lowercase # or 'BEM', or a regex pattern - - NestingDepth: - enabled: false - max_depth: 3 - - PlaceholderInExtend: - enabled: false - - PropertySortOrder: - enabled: false - ignore_unspecified: true - severity: warning - order: - - position - - top - - right - - bottom - - left - - z-index - - display - - float - - width - - min-width - - max-width - - height - - min-height - - max-height - - box-sizing - - padding - - padding-top - - padding-right - - padding-bottom - - padding-left - - margin - - margin-top - - margin-right - - margin-bottom - - margin-left - - overflow - - overflow-x - - overflow-y - - clip - - clear - - font - - font-family - - font-size - - font-style - - font-weight - - font-variant - - font-size-adjust - - font-stretch - - font-effect - - font-emphasize - - font-emphasize-position - - font-emphasize-style - - font-smooth - - hyphens - - line-height - - color - - text-align - - text-align-last - - text-emphasis - - text-emphasis-color - - text-emphasis-style - - text-emphasis-position - - text-decoration - - text-indent - - text-justify - - text-outline - - text-overflow - - text-overflow-ellipsis - - text-overflow-mode - - text-shadow - - text-transform - - text-wrap - - letter-spacing - - word-break - - word-spacing - - word-wrap - - tab-size - - white-space - - vertical-align - - list-style - - list-style-position - - list-style-type - - list-style-image - - pointer-events - - fill - - fill-opacity - - stroke - - stroke-opacity - - stroke-width - - shape-rendering - - cursor - - visibility - - zoom - - flex-direction - - flex-order - - flex-pack - - flex-align - - table-layout - - empty-cells - - caption-side - - border-spacing - - border-collapse - - content - - quotes - - counter-reset - - counter-increment - - resize - - user-select - - nav-index - - nav-up - - nav-right - - nav-down - - nav-left - - background - - background-color - - background-image - - filter - - background-repeat - - background-attachment - - background-position - - background-position-x - - background-position-y - - background-clip - - background-origin - - background-size - - border - - border-color - - border-style - - border-width - - border-top - - border-top-color - - border-top-style - - border-top-width - - border-right - - border-right-color - - border-right-style - - border-right-width - - border-bottom - - border-bottom-color - - border-bottom-style - - border-bottom-width - - border-left - - border-left-color - - border-left-style - - border-left-width - - border-radius - - border-top-left-radius - - border-top-right-radius - - border-bottom-right-radius - - border-bottom-left-radius - - border-image - - border-image-source - - border-image-slice - - border-image-width - - border-image-outset - - border-image-repeat - - outline - - outline-width - - outline-style - - outline-color - - outline-offset - - box-shadow - - opacity - - transition - - transition-delay - - transition-timing-function - - transition-duration - - transition-property - - transform - - transform-origin - - animation - - animation-name - - animation-duration - - animation-fill-mode - - animation-play-state - - animation-timing-function - - animation-delay - - animation-iteration-count - - animation-direction - - PropertySpelling: - enabled: true - extra_properties: [] - - QualifyingElement: - enabled: true - allow_element_with_attribute: false - allow_element_with_class: false - allow_element_with_id: false - - SelectorDepth: - enabled: true - max_depth: 4 - - SelectorFormat: - enabled: false - convention: hyphenated_lowercase # or 'BEM', or 'hyphenated_BEM', or 'snake_case', or 'camel_case', or a regex pattern - - Shorthand: - enabled: true - - SingleLinePerProperty: - enabled: true - allow_single_line_rule_sets: true - - SingleLinePerSelector: - enabled: true - - SpaceAfterComma: - enabled: true - - SpaceAfterPropertyColon: - enabled: true - style: one_space # or 'no_space', or 'at_least_one_space', or 'aligned' - - SpaceAfterPropertyName: - enabled: true - - SpaceBeforeBrace: - enabled: true - style: space # or 'new_line' - allow_single_line_padding: true - - SpaceBetweenParens: - enabled: true - spaces: 0 - - StringQuotes: - enabled: true - style: double_quotes - - TrailingSemicolon: - enabled: true - - TrailingZero: - enabled: false - - UnnecessaryMantissa: - enabled: true - - UnnecessaryParentReference: - enabled: true - - UrlFormat: - enabled: true - - UrlQuotes: - enabled: true - - VariableForProperty: - enabled: false - properties: [] - - VendorPrefix: - enabled: true - identifier_list: base - additional_identifiers: [] - excluded_identifiers: [] - - ZeroUnit: - enabled: true diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..cc7eee8a7a --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +Creative Commons Attribution 4.0 International License. (CC BY 4.0) + +Copyright (c) 2013 JASON LONG +https://github.com/jasonlong/cayman-theme + +This work is licensed under the +Creative Commons Attribution 4.0 International License. + +To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. diff --git a/README.md b/README.md index eca121ad80..296e3b0df8 100644 --- a/README.md +++ b/README.md @@ -31,15 +31,16 @@ To override the repository name or description from GitHub used in the header, a title: Custom title description: Custom description. show_downloads: false - +google_analytics: theme: jekyll-cayman ``` -Set `show_downloads` to `true` to show the download buttons in the header. +- Set `show_downloads` to `true` to show the download buttons in the header. +- Set `google_analytics` to your tracking ID to enable pageview tracking. #### CSS -For CSS customization, create your own `/assets/cayman.scss` in your project to replace the one from this theme. For convenience, the variables from `_sass/variables.scss` can simply be uncommented and their values modified. +For CSS customization, create your own `/assets/styles.scss` in your project to replace the one from this theme. For convenience, the variables from `_sass/variables.scss` can simply be uncommented and their values modified. A couple of nice sources for gradient colors are http://uigradients.com and http://jxnblk.com/shade/. @@ -82,13 +83,18 @@ $header-bg-color-secondary: #1F1C18; [Rouge](http://rouge.jneen.net/) is the default highlighter in Jekyll 3. This theme includes the `github` stylesheet from Rouge. -To switch syntax highlighting colors to say `monokai`, install the `rouge` gem and run the following on the command line. Then replace `rouge-githum` with `rouge-monkai` in `/assets/cayman.scss` +To switch syntax highlighting colors to say `monokai`, install the `rouge` gem and run the following on the command line. ``` mkdir _scss rougify style monokai > _scss/rouge-monokai.scss ``` +Then replace `rouge-github` with `rouge-monokai` in `/assets/styles.scss` + +Other pygments highlighter themes should work as well. + + ### License This work is licensed under a [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/) license. diff --git a/_config.yml b/_config.yml index dbbe967862..d2946c69c5 100644 --- a/_config.yml +++ b/_config.yml @@ -1,2 +1,5 @@ title: Cayman theme description: Cayman is a clean, responsive theme for GitHub Pages. +show_downloads: true +google_analytics: +theme: diff --git a/_layouts/default.html b/_layouts/default.html index e9533249b0..69c97b00b3 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -6,7 +6,7 @@ - + + {% if site.google_analytics %} + + + {% endif %} diff --git a/assets/cayman.scss b/assets/css/styles.scss similarity index 100% rename from assets/cayman.scss rename to assets/css/styles.scss diff --git a/cayman.gemspec b/jekyll-apg-theme-cayman.gemspec similarity index 79% rename from cayman.gemspec rename to jekyll-apg-theme-cayman.gemspec index 079a36fbe7..b5333a92e7 100644 --- a/cayman.gemspec +++ b/jekyll-apg-theme-cayman.gemspec @@ -1,11 +1,11 @@ # encoding: utf-8 Gem::Specification.new do |s| - s.name = "jekyll-cayman" + s.name = "jekyll-apg-theme-cayman" s.version = "0.0.1" s.authors = ["Jason Long"] s.email = ["support@github.com"] - s.homepage = "https://github.com/pages-themes/cayman" + s.homepage = "https://github.com/pages-themes/jekyll-apg-theme-cayman" s.summary = "Cayman is a clean, responsive theme for GitHub Pages" s.files = `git ls-files -z`.split("\x0").select do |f| diff --git a/script/cibuild b/script/cibuild index 3b3c04d986..f647a2ed5e 100755 --- a/script/cibuild +++ b/script/cibuild @@ -3,4 +3,4 @@ set -e bundle exec jekyll build -bundle exec gem build jekyll-cayman.gemspec +bundle exec gem build jekyll-apg-theme-cayman.gemspec diff --git a/thumbnail.png b/thumbnail.png new file mode 100644 index 0000000000..d06bb2a4a2 Binary files /dev/null and b/thumbnail.png differ