1
0
mirror of https://github.com/thangisme/notes.git synced 2025-01-03 01:36:23 -05:00

Fix docs and custom scss

This commit is contained in:
Patrick Marsceill 2019-08-14 10:40:19 -04:00
parent fe41e18994
commit 225604723a
No known key found for this signature in database
GPG Key ID: 286B93882D828F40
2 changed files with 133 additions and 123 deletions

View File

@ -1,120 +1,129 @@
// // ////
// // Typography //// Typography
// // ////
//
// $body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif;
// $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace;
// $root-font-size: 16px; // Base font-size for rems
// $body-line-height: 1.4;
// $body-heading-line-height: 1.15;
//
// //
// // Colors
// //
//
// $white: #fff;
//
// $grey-dk-000: #959396;
// $grey-dk-100: #5c5962;
// $grey-dk-200: #44434d;
// $grey-dk-250: #302d36 !default;
// $grey-dk-300: #27262b;
//
// $grey-lt-000: #f5f6fa;
// $grey-lt-100: #eeebee;
// $grey-lt-200: #ecebed;
// $grey-lt-300: #e6e1e8;
//
// $purple-000: #7253ed;
// $purple-100: #5e41d0;
// $purple-200: #4e26af;
// $purple-300: #381885;
//
// $blue-000: #2c84fa;
// $blue-100: #2869e6;
// $blue-200: #264caf;
// $blue-300: #183385;
//
// $green-000: #41d693;
// $green-100: #11b584;
// $green-200: #009c7b;
// $green-300: #026e57;
//
// $body-background-color: $white !default;
// $sidebar-color: $grey-lt-000 !default;
// $code-background-color: $grey-lt-000 !default;
// $body-text-color: $grey-dk-100 !default; //$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif;
// $body-heading-color: $grey-dk-300 !default; //$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace;
// $nav-child-link-color: $grey-dk-100 !default; //$root-font-size: 16px; // Base font-size for rems
// $link-color: $purple-000 !default; //$body-line-height: 1.4;
// $btn-primary-color: $purple-100 !default; //$content-line-height: 1.5;
// $base-button-color: #f7f7f7 !default; //$body-heading-line-height: 1.15;
//
// // ////
// // Media queries in pixels //// Colors
// // ////
//
// $media-queries: ( //$white: #fff;
// xs: 320px,
// sm: 500px, //$grey-dk-000: #959396;
// md: 740px, //$grey-dk-100: #5c5962;
// lg: 1120px, //$grey-dk-200: #44434d;
// xl: 1400px //$grey-dk-250: #302d36;
// ); //$grey-dk-300: #27262b;
//
// // //$grey-lt-000: #f5f6fa;
// // Spacing //$grey-lt-100: #eeebee;
// // //$grey-lt-200: #ecebed;
// //$grey-lt-300: #e6e1e8;
// $spacing-unit: 1rem; // 1rem == 16px
// //$purple-000: #7253ed;
// $spacers: ( //$purple-100: #5e41d0;
// sp-0: 0, //$purple-200: #4e26af;
// sp-1: $spacing-unit * 0.25, //$purple-300: #381885;
// sp-2: $spacing-unit * 0.5,
// sp-3: $spacing-unit * 0.75, //$blue-000: #2c84fa;
// sp-4: $spacing-unit, //$blue-100: #2869e6;
// sp-5: $spacing-unit * 1.5, //$blue-200: #264caf;
// sp-6: $spacing-unit * 2, //$blue-300: #183385;
// sp-7: $spacing-unit * 2.5,
// sp-8: $spacing-unit * 3, //$green-000: #41d693;
// sp-9: $spacing-unit * 3.5, //$green-100: #11b584;
// sp-10: $spacing-unit * 4 //$green-200: #009c7b;
// ); //$green-300: #026e57;
//
// $sp-1: map-get($spacers, sp-1); // 0.25 rem == 4px //$yellow-000: #ffeb82;
// $sp-2: map-get($spacers, sp-2); // 0.5 rem == 8px //$yellow-100: #fadf50;
// $sp-3: map-get($spacers, sp-3); // 0.75 rem == 12px //$yellow-200: #f7d12e;
// $sp-4: map-get($spacers, sp-4); // 1 rem == 16px //$yellow-300: #e7af06;
// $sp-5: map-get($spacers, sp-5); // 1.5 rem == 24px
// $sp-6: map-get($spacers, sp-6); // 2 rem == 32px //$red-000: #f77e7e;
// $sp-7: map-get($spacers, sp-7); // 2.5 rem == 40px //$red-100: #f96e65;
// $sp-8: map-get($spacers, sp-8); // 3 rem == 48px //$red-200: #e94c4c;
// $sp-9: map-get($spacers, sp-9); // 4 rem == 48px //$red-300: #dd2e2e;
// $sp-10: map-get($spacers, sp-10); // 4.5 rem == 48px
// //$body-background-color: $white;
// // //$sidebar-color: $grey-lt-000;
// // Borders //$search-background-color: $white;
// // //$table-background-color: $white;
// //$code-background-color: $grey-lt-000;
// $border: 1px solid;
// $border-radius: 4px; //$body-text-color: $grey-dk-100;
// $border-color: $grey-lt-100; //$body-heading-color: $grey-dk-300;
// //$search-result-preview-color: $grey-dk-000;
// // //$nav-child-link-color: $grey-dk-100;
// // Grid system //$link-color: $purple-000;
// // //$btn-primary-color: $purple-100;
// //$base-button-color: #f7f7f7;
// $gutter-spacing: $sp-6;
// $gutter-spacing-sm: $sp-4; ////
// $nav-width: 232px; //// Spacing
// $content-width: 800px; ////
//
// $media-queries: ( //$spacing-unit: 1rem; // 1rem == 16px
// xs: 320px,
// sm: 500px, //$spacers: (
// md: 740px, //sp-0: 0,
// lg: 800px, //sp-1: $spacing-unit * 0.25,
// xl: 1316px //sp-2: $spacing-unit * 0.5,
// ); //sp-3: $spacing-unit * 0.75,
//sp-4: $spacing-unit,
//sp-5: $spacing-unit * 1.5,
//sp-6: $spacing-unit * 2,
//sp-7: $spacing-unit * 2.5,
//sp-8: $spacing-unit * 3,
//sp-9: $spacing-unit * 3.5,
//sp-10: $spacing-unit * 4
//);
//$sp-1: map-get($spacers, sp-1); // 0.25 rem == 4px
//$sp-2: map-get($spacers, sp-2); // 0.5 rem == 8px
//$sp-3: map-get($spacers, sp-3); // 0.75 rem == 12px
//$sp-4: map-get($spacers, sp-4); // 1 rem == 16px
//$sp-5: map-get($spacers, sp-5); // 1.5 rem == 24px
//$sp-6: map-get($spacers, sp-6); // 2 rem == 32px
//$sp-7: map-get($spacers, sp-7); // 2.5 rem == 40px
//$sp-8: map-get($spacers, sp-8); // 3 rem == 48px
//$sp-9: map-get($spacers, sp-9); // 4 rem == 48px
//$sp-10: map-get($spacers, sp-10); // 4.5 rem == 48px
////
//// Borders
////
//$border: 1px solid;
//$border-radius: 4px;
//$border-color: $grey-lt-100;
////
//// Grid system
////
//$gutter-spacing: $sp-6;
//$gutter-spacing-sm: $sp-4;
//$nav-width: 264px;
//$nav-width-md: 248px;
//$content-width: 800px;
//$header-height: 60px;
//$search-results-width: 500px;
////
//// Media queries in pixels
////
//$media-queries: (
//xs: 320px,
//sm: 500px,
//md: $content-width,
//lg: $content-width + $nav-width,
//xl: 1400px
//);

View File

@ -26,6 +26,7 @@ View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/
```yaml ```yaml
# Enable or disable the site search # Enable or disable the site search
# Support true (default) or false
search_enabled: true search_enabled: true
``` ```
@ -38,11 +39,11 @@ aux_links:
- "//github.com/pmarsceill/just-the-docs" - "//github.com/pmarsceill/just-the-docs"
``` ```
## Heading anchors ## Heading anchor links
```yaml ```yaml
# Heading anchors appear on hover over h1-h6 tags # Heading anchor links appear on hover over h1-h6 tags
# allowing users to deep link to a particular heading # in page content allowing users to deep link to a particular
# on a page. # heading on a page.
# #
# Supprts true (default) or false/nil # Supprts true (default) or false/nil
heading_anchors: true heading_anchors: true