shawnteoh / matjek Goto Github PK

View Code? Open in Web Editor NEW

107.0 3.0 414.0 232 KB

Material theme based on Materialize.css for jekyll sites

Home Page: https://shawnteoh.github.io/matjek

License: GNU General Public License v3.0

Ruby 0.86% HTML 60.84% CSS 35.27% JavaScript 3.03%

jekyll theme jekyll-theme github-pages gh-pages

matjek's Introduction

MatJek

A responsive Material theme based on Materialize.css for jekyll sites.

Features

Google Analytics
Disqus
GitHub project page
Tags and Categories
Modular CSS and JS includes (example)
Fancy "About" page

Installation

Clone or fork this repo and edit _config.yml as needed.

Configuration

Most of the configurations can be found in _config.yml. The configurations listed below are specific to MatJek. If you are not using google_tracking_id or disqus_shortname, just remove them completely.

github_profile: "github_profile_url"
user: "your_name" # Appears at sidebar
user_email: "your_email" # Appears at sidebar, remove whole variable if unwanted
contact_url: "google_form_link"
google_tracking_id: "google_analytics_ID"
disqus_shortname: "shortname_given_by_Disqus"

Edit the images in assets/res to suit your liking, but try to stick to the original resolutions.

If you would like to enable comments in a post (disqus_shortname must be provided), add this line to the front matter of the post.

comments: 1

Add tags and categories to your posts in the front matter as well. Multiple tags/categories can be assigned but need to be separated by spaces.

categories: default default2
tags: test test2

Contributing

Bug reports and pull requests are welcomed on GitHub at https://github.com/shawnteoh/matjek. 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.

Development

To set up your environment to develop this theme, clone/fork the repo and run bundle install.

To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000/matjek/. 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.

License

The theme is available as open source under the terms of the GPL v3 License.

Libraries

References

matjek's People

Contributors

Stargazers

Watchers

Forkers

fathomson sirkapil lschuetze rodolfoferro hippyjake harunisiaho lp11196 vikramnr suhailtajshaik knightyun filips123 shijies musanl vincent-ng mbakriani nilsonlinux nilsonsoft buithoai laijeff xing0231 nikos912000 sunzhida ashley-920 gopikrishnaaa jmhmunhwan qrdlvnqww2z1ztmj ayrymlipsecocfb bounce00 taylor-liu simhr 201511026 alexlaurence eunhwa0430 ddmanager hiker90 sj-spencer jguard01 wfnian6 princejwg w0sephiroth maomao2046 qianhwan richeycheng nosecurityblog superhaifeng camadi itsayushthada zicoabhidey yzcx pjetursig azureadolescence bestbai happy-hxt tinpham1993 shengshibanyue hvdthong xahhy yongsu9630 lushuaifu nancyqiuun huxianyin quockhanhtest imam76 jyp-sw fattyface hyaluronicc duongtunganh yzhao430 hr004 wendyulacio 31833077 gurinder-trantor tetrag7 zeospec haewonp tansenl diegoexploit river9977 soke58 xiaohao-cloud annabelleyun blogbak ryogaotake vadpost zxdnoob rigizer abogncctlgn dufei99 jungjaehee zzfd gustjr8742 wsdsb xmc91 dylanbai8 blueyellow20 navlikespotatoes 3dvision-zju toskachin kim-woo-gyeong larryh1998

@ShawnTeoh I'm Brazilian and I loved your project matjek I use your theme on my blog, and it's great, but I have some comments to make regarding the posts.

I find it somewhat limited, simple things like:

`SETUP`

Description	Packages
`Window Manager`	`i3gaps` - `bspwm`
`Bar`	`i3blocks` - `polybar`
`Terminal Emulator`	`termite`
`Compositor`	`compton`
`File Manager`	`nautilus`
`Text Editor`	`leafpad`
`Font`	`Fantasque Sans Mono`
`Program Launcher`	`dmenu2`
`Browser`	`google-chrome`
`Music`	`mpd` - `ncmpcpp`
`Video`	`mplayer`
`IDE`	`visual-studio-code`

There is no way to do it, or the design does not fit very well.

I think your design is great, I use your template and I like it very much, I took the liberty of searching some other templates for you to have inspiration and if you want to copy these features and adapt to your template that is very good indeed.

Demonstration:

https://tianqi.name/jekyll-TeXt-theme/test/2016/06/10/tables.html

https://tianqi.name/jekyll-TeXt-theme/test/2017/08/08/additional-styles.html

Project GitHub page: https://github.com/kitian616/jekyll-TeXt-theme

Demonstration:

https://iwiedenm.github.io/jekyll-theme-massively/elements/

Project GitHub page: https://github.com/iwiedenm/jekyll-theme-massively-src

I hope you can read this issue, I would very much like you to carry out this update to make your template even more complete, and enrich the posts area of the site. Thank you!

Save from Brazil!

Accessibility errors found in your template

The user @carlsonsantana validate your site template "https://shawnteoh.github.io/matjek" and found these accessibility errors:

Page https://shawnteoh.github.io/matjek/:
- Issue e5edf0d3-bdd7-4829-ae6c-52ef77d1e6e3:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 1.95:1. Recommendation: change background to #00574f.
 - Selector: html > body > footer > div:nth-child(1) > div > div > p > a
 - Context: <a href="http://materializecss.com">Materialize.css</a>
- Issue 3d19696a-5095-42a8-b932-f1c39abfacf1:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.37:1. Recommendation: change background to #007e72.
 - Selector: html > body > footer > div:nth-child(1) > div > div > p
 - Context: Material theme based on <a href...
- Issue 1cb7b637-71ba-4a11-a9e5-c99ece9dc02b:
 - Type: Error
 - Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
 - Message: This link points to a named anchor "!" within the document, but no anchor exists with that name.
 - Selector: html > body > main > div > div:nth-child(2) > div > div:nth-child(4) > ul > li:nth-child(3) > a
 - Context: <a href="#!">
- Issue 8e77c2c7-85c6-48ec-8216-6fb53ef30ae4:
 - Type: Error
 - Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
 - Message: This link points to a named anchor "!" within the document, but no anchor exists with that name.
 - Selector: html > body > main > div > div:nth-child(2) > div > div:nth-child(4) > ul > li:nth-child(2) > a
 - Context: <a href="#!">1</a>
- Issue b95eefc9-b05e-411d-bc52-ee261fb8066e:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.67:1. Recommendation: change background to #008579.
 - Selector: html > body > main > div > div:nth-child(2) > div > div:nth-child(4) > ul > li:nth-child(2) > a
 - Context: <a href="#!">1</a>
- Issue 61bb5d0d-2717-4659-83d3-a37123e2ac67:
 - Type: Error
 - Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
 - Message: This link points to a named anchor "!" within the document, but no anchor exists with that name.
 - Selector: html > body > main > div > div:nth-child(2) > div > div:nth-child(4) > ul > li:nth-child(1) > a
 - Context: <a href="#!">
- Issue 9ad02609-4578-4ff6-b52a-66aebe1a16dd:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 1.88:1. Recommendation: change text colour to #b16300.
 - Selector: html > body > main > div > div:nth-child(2) > div > div:nth-child(3) > div > div:nth-child(2) > a
 - Context: <a href="/matjek/2017/03/23/welcome-to-jekyll">Read More</a>
- Issue 0b05fdab-1bd2-4fe1-a893-e676bcaa01dd:
 - Type: Error
 - Code: WCAG2AA.Principle4.Guideline4_1.4_1_1.F77
 - Message: Duplicate id attribute value "post-content" found on the web page.
 - Selector: #post-content
 - Context: You’ll find this post in your <...
- Issue f726931c-e351-419c-b2da-d4f2a26724af:
 - Type: Error
 - Code: WCAG2AA.Principle4.Guideline4_1.4_1_1.F77
 - Message: Duplicate id attribute value "post-date" found on the web page.
 - Selector: #post-date
 - Context: 
- Issue 008fa481-504e-445c-8e44-2b0725cc9335:
 - Type: Error
 - Code: WCAG2AA.Principle4.Guideline4_1.4_1_1.F77
 - Message: Duplicate id attribute value "post-title" found on the web page.
 - Selector: #post-title
 - Context: Welcome to Jekyll!
- Issue 3964b696-61ad-459b-bbcc-7130799d7cf4:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 1.88:1. Recommendation: change text colour to #b16300.
 - Selector: html > body > main > div > div:nth-child(2) > div > div:nth-child(2) > div > div:nth-child(2) > a
 - Context: <a href="/matjek/2017/03/24/syntax-test">Read More</a>
- Issue a7d698aa-82e3-44d0-ad7b-fd95a0c50100:
 - Type: Error
 - Code: WCAG2AA.Principle4.Guideline4_1.4_1_1.F77
 - Message: Duplicate id attribute value "post-content" found on the web page.
 - Selector: #post-content
 - Context: Jekyll uses Rouge by default fo...
- Issue 5d4fe169-5a0c-43ba-add4-6fe619714320:
 - Type: Error
 - Code: WCAG2AA.Principle4.Guideline4_1.4_1_1.F77
 - Message: Duplicate id attribute value "post-date" found on the web page.
 - Selector: #post-date
 - Context: 
- Issue babfb7c5-8615-44dc-a6bc-64600baaf923:
 - Type: Error
 - Code: WCAG2AA.Principle4.Guideline4_1.4_1_1.F77
 - Message: Duplicate id attribute value "post-title" found on the web page.
 - Selector: #post-title
 - Context: Syntax Highlighting Test
- Issue 70dacc6f-8afa-4989-97eb-ac611e54fd65:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 1.88:1. Recommendation: change text colour to #b16300.
 - Selector: html > body > main > div > div:nth-child(2) > div > div:nth-child(1) > div > div:nth-child(2) > a
 - Context: <a href="/matjek/2017/03/25/another-post">Read More</a>
- Issue e38d7123-af27-4e74-925f-df904499a2c5:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.H42.2
 - Message: Heading tag found with no content. Text that is not intended as a heading should not be marked up with heading tags.
 - Selector: #page-info > h3
 - Context: <h3></h3>
- Issue 88091f70-6f44-4b46-8a0d-d7a652fd320b:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 1:1. Recommendation: change text colour to #767676.
 - Selector: #slide-out > li:nth-child(1) > div > span:nth-child(4)
 - Context: [email protected]
- Issue 7faae8bd-40aa-445c-a4bc-4e64113b771f:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
 - Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 1:1. Recommendation: change text colour to #767676.
 - Selector: #slide-out > li:nth-child(1) > div > span:nth-child(3)
 - Context: John Doe
- Issue b9daa4cc-9174-411b-aa2e-660b7401b055:
 - Type: Error
 - Code: WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2
 - Message: Img element is the only content of the link, but is missing alt text. The alt text should describe the purpose of the link.
 - Selector: #slide-out > li:nth-child(1) > div > a
 - Context: <a href="https://github.com/ShawnTeoh" target="_blank"><img class="circle z-depth-2" s...</a>
- Issue 44dee7c4-499a-40d8-a56b-0c308e3e94d7:
 - Type: Error
 - Code: WCAG2AA.Principle3.Guideline3_1.3_1_1.H57.2
 - Message: The html element should have a lang or xml:lang attribute which describes the language of the document.
 - Selector: html
 - Context: <html><head><meta http-equiv="Co...</html>

You can check these accessibility errors using pa11y.
You can view the full validation results in our website.

Your theme is listed in jekyllthemes.ru

Your theme has been listed on http://jekyllthemes.ru/

Invalid US-ASCII character

Getting error below when trying to build.

  Conversion error: Jekyll::Converters::Scss encountered an error while converting 'assets/css/style.scss':
                    Invalid US-ASCII character "\xE2" on line 5
jekyll 3.6.2 | Error:  Invalid US-ASCII character "\xE2" on line 5

GitHub project page Link not working

Fix Github Project Page Link

Recommend Projects

React

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

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

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.

shawnteoh / matjek Goto Github PK

matjek's Introduction

MatJek

Features

Installation

Configuration

Contributing

Development

License

Libraries

References

matjek's People

Contributors

Stargazers

Watchers

Forkers

matjek's Issues

@ShawnTeoh I'm Brazilian and I loved your project matjek I use your theme on my blog, and it's great, but I have some comments to make regarding the posts.

I find it somewhat limited, simple things like:

SETUP

There is no way to do it, or the design does not fit very well.

I think your design is great, I use your template and I like it very much, I took the liberty of searching some other templates for you to have inspiration and if you want to copy these features and adapt to your template that is very good indeed.

Demonstration:

Project GitHub page: https://github.com/kitian616/jekyll-TeXt-theme

Demonstration:

Project GitHub page: https://github.com/iwiedenm/jekyll-theme-massively-src

I hope you can read this issue, I would very much like you to carry out this update to make your template even more complete, and enrich the posts area of ​​the site. Thank you!

Save from Brazil!

Recommend Projects

Recommend Topics

Recommend Org

`SETUP`

I hope you can read this issue, I would very much like you to carry out this update to make your template even more complete, and enrich the posts area of the site. Thank you!