GithubHelp home page GithubHelp logo

crispgm / minimal Goto Github PK

View Code? Open in Web Editor NEW
9.0 3.0 6.0 1.7 MB

A minimalism theme for Jekyll

Home Page: https://crispgm.github.io/minimal

License: MIT License

HTML 31.44% CSS 13.53% Ruby 5.73% SCSS 49.30%

minimal's Introduction

Jekyll Crisp Minimal Theme

Gem Version

Minimal theme of Jekyll from Crisp.

Sample Site

Installation

  1. To install a theme, first, add the theme to your site's Gemfile:

    gem 'jekyll-crisp-minimal-theme'
    
  2. Save the changes to your Gemfile

  3. Run the command bundle install to install the theme

  4. Finally, activate the theme by adding the following to your site's _config.yml:

    theme: jekyll-crisp-minimal-theme
    

For more information, please read https://jekyllrb.com/docs/themes/.

Contents

Layouts

  • 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.
  • page.html: The layout for your documents that contain FrontMatter, but are not posts.
  • post.html: The layout for your posts.
  • redirect.html: The layout for redirections, which redirects following the FrontMatter redirect_to.

Includes

  • disqus.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.

Sass

  • style.scss: Defines the variable defaults for the theme and also further imports sass partials to supplement itself.
  • _main.scss: Defines the base styles for various HTML elements.
  • _archive.scss: Defines the styles for archive list.
  • _article.scss: Defines the styles for articles.
  • _code-highlight.scss: Defines the styles for syntax-highlighting.
  • _footer.scss: Defines the styles for footer.
  • _menu.scss: Defines the styles for header(menu).
  • _page.scss: Defines the styles for page.
  • _things.scss: Defines the styles for project list.

Assets

This directory includes sufficient css, js, and images used for the theme.

Usage

FrontMatter Variables

  • disable_syntax_highlight: Default to false. By setting true, highlight.js will not be loaded or initiated. Recommended for non-code pages.
  • jquery: Default to false. By setting true, jQuery will be loaded.

Menu

Header menu can be customized. Add original file (not target file) path to site.menu.

  menu:
    - my_md_page.md
    - my_html_page.html

Contact Icons

Contact icons can be set in site.contact. To add more contact icons, attach new items with link and icon to your target position.

  contact:
    - link: https://crispgm.github.io/minimal/
      icon: fa-globe

Project

Project page is a place to show the information sheet of your projects. You may use _data file to organize the page, or even use github-metadata to do that.

Disqus

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.

Google Analytics

To enable Google Anaytics, 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

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/crispgm/minimal. 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.

License

MIT

minimal's People

Contributors

crispgm avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

minimal's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.