chameleon-jekyll-theme
Advanced tools
Chameleon is a Jekyll theme. It's at v0.0.0; so not quite ready ... right now it looks just like minima.
Add this line to your Jekyll site's Gemfile:
gem "chameleon-jekyll-theme"
And add this line to your Jekyll site:
theme: chameleon-jekyll-theme
And then execute:
$ bundle
Chameleon has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration, in which case it will look like the Jekyll default theme Minima. You can then configure Chameleon to take on various appearances.
Refers to files within the _layouts directory, that define the markup for your theme.
default.html — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says {{ content }} and are linked to this file via FrontMatter declaration layout: default.home.html — The layout for your landing-page / home-page / index-page. [More Info.]page.html — The layout for your documents that contain FrontMatter, but are not posts.post.html — The layout for your posts.Refers to snippets of code within the _includes directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
disqus_comments.html — Code to markup disqus comment box.footer.html — Defines the site's footer section.google-analytics.html — Inserts Google Analytics module (active only in production environment).head.html — Code-block that defines the <head></head> in default layout.header.html — Defines the site's main header section. By default, pages with a defined title attribute will have links displayed here.Refers to .scss files within the _sass directory that define the theme's styles.
chameleon.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.chameleon/_base.scss — Resets and defines base styles for various HTML elements.chameleon/_layout.scss — Defines the visual style for various layouts.chameleon/_syntax-highlighting.scss — Defines the styles for syntax-highlighting.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.
Chameleon comes with jekyll-seo-tag plugin preinstalled to make sure your website gets the most useful meta tags. See usage to know how to set it up.
home.html is a flexible HTML layout for the site's landing-page / home-page / index-page.
The home layout will inject all content from your index.md / index.html before the Posts heading. This will allow you to include non-posts related content to be published on the landing page under a dedicated heading. It us recommended that you title this section with a Heading2 (##).
Usually the site.title itself would suffice as the implicit 'main-title' for a landing-page. But, if your landing-page would like a heading to be explicitly displayed, then simply define a title variable in the document's front matter and it will be rendered with an <h1> tag.
This section is optional.
It will be automatically included only when your site contains one or more valid posts or drafts (if the site is configured to show_drafts).
The title for this section is Posts by default and rendered with an <h2> tag. You can customize this heading by defining a list_title variable in the document's front matter.
--
To override the default structure and style of Chameleon, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file.
e.g., to override the _includes/head.html file to specify a custom style path, create an _includes directory, copy _includes/head.html from Chameleon gem folder to <yoursite>/_includes and start editing that file.
The site's default CSS is within the gem itself, assets/main.scss. To override the default CSS, the file has to exist at your site source. Do either of the following:
main.scss at site source.
main.scss at <your-site>/assets/@import "minima";, to <your-site>/assets/main.scssmain.scss at <your-site>/assets/main.scss you just created, and edit away!bundle show chameleon to get the path to it ).assets/ folder from there into the root of <your-site><your-site>/assets/main.scss--
This allows you to set which pages you want to appear in the navigation area and configure order of the links.
For instance, to only link to the about and the portfolio page, add the following to you _config.yml:
header_pages:
- about.md
- portfolio.md
--
You can change the default date format by specifying site.minima.date_format
in _config.yml.
# Date format
# refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this
minima:
date_format: "%b %-d, %Y"
--
Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
To enable it, add the following lines to your Jekyll site:
disqus:
shortname: my_disqus_shortname
You can find out more about Disqus' shortnames here.
Comments are enabled by default and will only appear in production, i.e., JEKYLL_ENV=production
If you don't want to display comments for a particular post you can disable them by adding comments: false to that post's YAML Front Matter.
--
You can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your config:
twitter_username: usename
github_username: username
dribbble_username: username
facebook_username: username
flickr_username: username
instagram_username: username
linkedin_username: username
pinterest_username: username
youtube_username: username
googleplus_username: username
rss: rss
mastodon:
- username: username
instance: example.com
- username: username
instance: example.com
--
To enable Google Analytics, add the following lines to your Jekyll site:
google_analytics: UA-NNNNNNNN-N
Google Analytics will only appear in production, i.e., JEKYLL_ENV=production
--
To display post-excerpts on the Home Page, simply add the following to your _config.yml:
show_excerpts: true
Bug reports and pull requests are welcome on GitHub at https://github.com/rogerbw/chameleon. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
To set up your environment to develop this theme, run script/bootstrap.
To test your theme, run script/server (or bundle exec jekyll serve) and open your browser at http://localhost:4000. 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.
The theme is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that chameleon-jekyll-theme demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.