knowledge/awesome-cheatsheets
1
1
Fork 0
mirror of https://github.com/namibia/awesome-cheatsheets.git synced 2024-11-22 04:45:16 +00:00
Code Issues Releases Activity

feat(github-buttons): stars, watch, fork and follow

Browse Source
This commit is contained in:
Julien 2018-09-10 10:14:05 +02:00
parent d9a67287b6
commit 70c39d3371
5 changed files with 431 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

282
assets/tools/_mq.scss Normal file
View File

@ -0,0 +1,282 @@
/**************************************************************************
TOOLS > SASS MQ
https://github.com/sass-mq/sass-mq/blob/master/_mq.scss
***************************************************************************/
@charset "UTF-8"; // Fixes an issue where Ruby locale is not set properly
// See https://github.com/sass-mq/sass-mq/pull/10
/// Base font size on the `<body>` element
/// @type Number (unit)
$mq-base-font-size: 16px !default;
/// Responsive mode
///
/// Set to `false` to enable support for browsers that do not support @media queries,
/// (IE <= 8, Firefox <= 3, Opera <= 9)
///
/// You could create a stylesheet served exclusively to older browsers,
/// where @media queries are rasterized
///
/// @example scss
/// // old-ie.scss
/// $mq-responsive: false;
/// @import 'main'; // @media queries in this file will be rasterized up to $mq-static-breakpoint
/// // larger breakpoints will be ignored
///
/// @type Boolean
/// @link https://github.com/sass-mq/sass-mq#responsive-mode-off Disabled responsive mode documentation
$mq-responsive: true !default;
/// Breakpoint list
///
/// Name your breakpoints in a way that creates a ubiquitous language
/// across team members. It will improve communication between
/// stakeholders, designers, developers, and testers.
///
/// @type Map
/// @link https://github.com/sass-mq/sass-mq#seeing-the-currently-active-breakpoint Full documentation and examples
$mq-breakpoints: (
mobile: 320px,
tablet: 740px,
desktop: 980px,
wide: 1300px,
superwide: 1800px
) !default;
/// Static breakpoint (for fixed-width layouts)
///
/// Define the breakpoint from $mq-breakpoints that should
/// be used as the target width for the fixed-width layout
/// (i.e. when $mq-responsive is set to 'false') in a old-ie.scss
///
/// @example scss
/// // tablet-only.scss
/// //
/// // Ignore all styles above tablet breakpoint,
/// // and fix the styles (e.g. layout) at tablet width
/// $mq-responsive: false;
/// $mq-static-breakpoint: tablet;
/// @import 'main'; // @media queries in this file will be rasterized up to tablet
/// // larger breakpoints will be ignored
///
/// @type String
/// @link https://github.com/sass-mq/sass-mq#adding-custom-breakpoints Full documentation and examples
$mq-static-breakpoint: desktop !default;
/// Show breakpoints in the top right corner
///
/// If you want to display the currently active breakpoint in the top
/// right corner of your site during development, add the breakpoints
/// to this list, ordered by width, e.g. (mobile, tablet, desktop).
///
/// @type map
$mq-show-breakpoints: () !default;
/// Customize the media type (e.g. `@media screen` or `@media print`)
/// By default sass-mq uses an "all" media type (`@media all and …`)
///
/// @type String
/// @link https://github.com/sass-mq/sass-mq#changing-media-type Full documentation and examples
$mq-media-type: all !default;
/// Convert pixels to ems
///
/// @param {Number} $px - value to convert
/// @param {Number} $base-font-size ($mq-base-font-size) - `<body>` font size
///
/// @example scss
/// $font-size-in-ems: mq-px2em(16px);
/// p { font-size: mq-px2em(16px); }
///
/// @requires $mq-base-font-size
/// @returns {Number}
@function mq-px2em($px, $base-font-size: $mq-base-font-size) {
@if unitless($px) {
@warn "Assuming #{$px} to be in pixels, attempting to convert it into pixels.";
@return mq-px2em($px * 1px, $base-font-size);
} @else if unit($px) == em {
@return $px;
}
@return ($px / $base-font-size) * 1em;
}
/// Get a breakpoint's width
///
/// @param {String} $name - Name of the breakpoint. One of $mq-breakpoints
///
/// @example scss
/// $tablet-width: mq-get-breakpoint-width(tablet);
/// @media (min-width: mq-get-breakpoint-width(desktop)) {}
///
/// @requires {Variable} $mq-breakpoints
///
/// @returns {Number} Value in pixels
@function mq-get-breakpoint-width($name, $breakpoints: $mq-breakpoints) {
@if map-has-key($breakpoints, $name) {
@return map-get($breakpoints, $name);
} @else {
@warn "Breakpoint #{$name} wasn't found in $breakpoints.";
}
}
/// Media Query mixin
///
/// @param {String | Boolean} $from (false) - One of $mq-breakpoints
/// @param {String | Boolean} $until (false) - One of $mq-breakpoints
/// @param {String | Boolean} $and (false) - Additional media query parameters
/// @param {String} $media-type ($mq-media-type) - Media type: screen, print…
///
/// @ignore Undocumented API, for advanced use only:
/// @ignore @param {Map} $breakpoints ($mq-breakpoints)
/// @ignore @param {String} $static-breakpoint ($mq-static-breakpoint)
///
/// @content styling rules, wrapped into a @media query when $responsive is true
///
/// @requires {Variable} $mq-media-type
/// @requires {Variable} $mq-breakpoints
/// @requires {Variable} $mq-static-breakpoint
/// @requires {function} mq-px2em
/// @requires {function} mq-get-breakpoint-width
///
/// @link https://github.com/sass-mq/sass-mq#responsive-mode-on-default Full documentation and examples
///
@mixin mq(
$from: false,
$until: false,
$and: false,
$media-type: $mq-media-type,
$breakpoints: $mq-breakpoints,
$responsive: $mq-responsive,
$static-breakpoint: $mq-static-breakpoint
) {
$min-width: 0;
$max-width: 0;
$media-query: "";
// From: this breakpoint (inclusive)
@if $from {
@if type-of($from) == number {
$min-width: mq-px2em($from);
} @else {
$min-width: mq-px2em(mq-get-breakpoint-width($from, $breakpoints));
}
}
// Until: that breakpoint (exclusive)
@if $until {
@if type-of($until) == number {
$max-width: mq-px2em($until);
} @else {
$max-width: mq-px2em(mq-get-breakpoint-width($until, $breakpoints)) -
0.01em;
}
}
// Responsive support is disabled, rasterize the output outside @media blocks
// The browser will rely on the cascade itself.
@if $responsive == false {
$static-breakpoint-width: mq-get-breakpoint-width(
$static-breakpoint,
$breakpoints
);
$target-width: mq-px2em($static-breakpoint-width);
// Output only rules that start at or span our target width
@if (
$and ==
false and
$min-width <=
$target-width and
($until == false or $max-width >= $target-width)
) {
@content;
}
}
// Responsive support is enabled, output rules inside @media queries
@else {
@if $min-width != 0 {
$media-query: "#{$media-query} and (min-width: #{$min-width})";
}
@if $max-width != 0 {
$media-query: "#{$media-query} and (max-width: #{$max-width})";
}
@if $and {
$media-query: "#{$media-query} and #{$and}";
}
// Remove unnecessary media query prefix 'all and '
@if ($media-type == "all" and $media-query != "") {
$media-type: "";
$media-query: str-slice(unquote($media-query), 6);
}
@media #{$media-type + $media-query} {
@content;
}
}
}
/// Add a breakpoint
///
/// @param {String} $name - Name of the breakpoint
/// @param {Number} $width - Width of the breakpoint
///
/// @requires {Variable} $mq-breakpoints
///
/// @example scss
/// @include mq-add-breakpoint(tvscreen, 1920px);
/// @include mq(tvscreen) {}
@mixin mq-add-breakpoint($name, $width) {
$new-breakpoint: (
$name: $width
);
$mq-breakpoints: map-merge($mq-breakpoints, $new-breakpoint) !global;
}
/// Show the active breakpoint in the top right corner of the viewport
/// @link https://github.com/sass-mq/sass-mq#seeing-the-currently-active-breakpoint
///
/// @param {List} $show-breakpoints ($mq-show-breakpoints) - List of breakpoints to show in the top right corner
/// @param {Map} $breakpoints ($mq-breakpoints) - Breakpoint names and sizes
///
/// @requires {Variable} $mq-breakpoints
/// @requires {Variable} $mq-show-breakpoints
///
/// @example scss
/// // Show breakpoints using global settings
/// @include mq-show-breakpoints;
///
/// // Show breakpoints using custom settings
/// @include mq-show-breakpoints((L, XL), (S: 300px, L: 800px, XL: 1200px));
@mixin mq-show-breakpoints(
$show-breakpoints: $mq-show-breakpoints,
$breakpoints: $mq-breakpoints
) {
body:before {
background-color: #fcf8e3;
border-bottom: 1px solid #fbeed5;
border-left: 1px solid #fbeed5;
color: #c09853;
font: small-caption;
padding: 3px 6px;
pointer-events: none;
position: fixed;
right: 0;
top: 0;
z-index: 3;
// Loop through the breakpoints that should be shown
@each $show-breakpoint in $show-breakpoints {
$width: mq-get-breakpoint-width($show-breakpoint, $breakpoints);
@include mq($show-breakpoint, $breakpoints: $breakpoints) {
content: "#{$show-breakpoint} ≥ #{$width} (#{mq-px2em($width)})";
}
}
}
}
@if length($mq-show-breakpoints) > 0 {
@include mq-show-breakpoints;
}

112
components/TheGithubButtons.vue Normal file
View File

@ -0,0 +1,112 @@
<!-- *************************************************************************
TEMPLATE
************************************************************************* -->
<template lang="pug">
.c-the-github-buttons
span.c-the-github-buttons__wrapper
iframe(
:src="'https://ghbtns.com/github-btn.html?user=' + user + '&repo=' + repo + '&type=star&count=true'"
frameborder="0"
scrolling="0"
height="20px"
class="c-the-github-buttons__button c-the-github-buttons__button--star"
)
span.c-the-github-buttons__wrapper
iframe(
:src="'https://ghbtns.com/github-btn.html?user=' + user + '&repo=' + repo + '&type=watch&count=true&v=2'"
frameborder="0"
scrolling="0"
height="20px"
class="c-the-github-buttons__button c-the-github-buttons__button--watch"
)
span.c-the-github-buttons__wrapper
iframe(
:src="'https://ghbtns.com/github-btn.html?user=' + user + '&repo=' + repo + '&type=fork&count=true'"
frameborder="0"
scrolling="0"
height="20px"
class="c-the-github-buttons__button c-the-github-buttons__button--fork"
)
span.c-the-github-buttons__wrapper
iframe(
:src="'https://ghbtns.com/github-btn.html?user=' + user + '&type=follow&count=true'"
frameborder="0"
scrolling="0"
height="20px"
class="c-the-github-buttons__button c-the-github-buttons__button--follow"
)
</template>
<!-- *************************************************************************
SCRIPT
************************************************************************* -->
<script>
export default {
props: {
repo: {
type: String,
required: true
},
user: {
type: String,
required: true
}
}
};
</script>
<!-- *************************************************************************
STYLE
************************************************************************* -->
<style lang="scss">
$c: ".c-the-github-buttons";
#{$c} {
#{$c}__wrapper {
display: inline-block;
margin-bottom: 20px;
width: 100%;
#{$c}__button {
margin: 0 auto;
&--star {
width: 110px;
}
&--watch {
width: 110px;
}
&--fork {
width: 100px;
}
&--follow {
width: 160px;
}
&:nth-last-of-type  {
margin-bottom: 0;
}
}
}
}
@include mq($from: tablet) {
#{$c} {
display: flex;
justify-content: center;
#{$c}__wrapper {
width: initial;
}
}
}
</style>

4
layouts/default.vue
View File

@ -26,7 +26,7 @@ import TheCopyright from "@/components/TheCopyright";
export default {
components: {
TheGithub,
TheGithubCorner,
TheCopyright
}
};
@ -44,7 +44,7 @@ $c: ".l-default";
html {
overflow-y: scroll;
box-sizing: border-box;
padding: 60px 0;
padding: 60px 0 80px;
min-height: 100%;
background-color: $mirage;
color: white;

5
nuxt.config.js
View File

@ -33,7 +33,10 @@ module.exports = {
"nuxt-sass-resources-loader",
[
// Global variables, site-wide settings, config switches, etc
"@/assets/settings/_colors.scss"
"@/assets/settings/_colors.scss",
// Site-wide mixins and functions
"@/assets/tools/_mq.scss"
]
]
],

33
pages/index.vue
View File

@ -19,6 +19,12 @@
| Awesome cheatsheets for popular programming languages, frameworks and development tools.<br/>
| They include everything you should know in one single file. 👩‍💻👨‍💻
the-github-buttons(
repo="awesome-cheatsheets"
user="LeCoupa"
class="c-index__github-buttons"
)
section(
v-for="(category, index) in categories"
:key="category.name"
@ -43,7 +49,14 @@
************************************************************************* -->
<script>
// PROJECT
import TheGithubButtons from "@/components/TheGithubButtons";
export default {
components: {
TheGithubButtons
},
data() {
return {
// --> STATE <--
@ -224,11 +237,15 @@ $c: ".c-index";
#{$c}__description {
margin: 0;
margin: 30px 0 40px;
font-size: 22px;
margin: 30px 0;
font-size: 18px;
line-height: 32px;
}
#{$c}__github-buttons {
margin-bottom: 40px;
}
#{$c}__category {
margin-bottom: 40px;
@ -248,4 +265,16 @@ $c: ".c-index";
}
}
}
@include mq($from: tablet) {
#{$c} {
#{$c}__description {
font-size: 22px;
}
#{$c}__github-buttons {
margin-bottom: 60px;
}
}
}
</style>