Verified Commit f5911980 authored by Jamie Maynard's avatar Jamie Maynard
Browse files

Handbook Markdown Style guide 

This commits adds the markdwon style guide to the docs which will make
it available to both new handbook sites.  It adds shortcodes for:

* a (anchor)
* comment
* details
* note
* panel
* site-title
* site-url

It also makes the theme project a hugo runable site in its own right
which allows for easier modifications to the theme.
parent 52b3a03e

.editorconfig

0 → 100644
+16 −0
Original line number Diff line number Diff line 
root = true



[*]

charset = utf-8

end_of_line = lf

trim_trailing_whitespace = true

insert_final_newline = true



[{.,}*.{js{,*},y{a,}ml}]

indent_style = space

indent_size = 2



[*.{md,txt,COMMIT_EDITMSG}]

indent_style = space

indent_size = 4

max_line_length = 120

.markdownlint-cli2.jsonc

0 → 100644
+6 −0
Original line number Diff line number Diff line 
{

  "outputFormatters": [

    [ "markdownlint-cli2-formatter-codequality" ],

    [ "markdownlint-cli2-formatter-pretty" ]

  ]

}

.markdownlint.yaml

0 → 100644
+18 −0
Original line number Diff line number Diff line 
default: true

link-fragments: false

no-space-in-emphasis: false

blanks-around-lists: false

MD013:

  line_length: 120

  tables: false

no-inline-html: false

no-bare-urls: false

no-emphasis-as-heading: false

no-multiple-blanks: false

no-trailing-punctuation: false

heading-increment: false

heading-style:

  style: atx

ul-indent: false

ul-style:

  style: dash

assets/scss/_styles_project.scss

+70 −8
Original line number Diff line number Diff line 
@import "codeowners";



.gdoc {

  display:flex;

  margin:0;

  padding:0;

  height: 30em;

  width: 100%;

  border-radius: $border-radius;

  border: 1px solid rgba(0, 0, 0, 0.125);

  resize:both;

  overflow:hidden

}



.gdoc > iframe {

  flex-grow:1;

  margin:0;

  padding:0;

  border:0;

  height: 100%;

  width:100%;

}



.td-page body {

  scroll-margin-top: 4.5rem !important; /* height of sticky header */

}



.td-main main {

  padding-right: 3rem !important;

}
@@ -28,15 +53,52 @@ 
  max-width: 80%;

}



.card-body {

  padding: 0;

  margin: 1rem 0;

.note {

  font-size: 0.8rem;

  font-style: italic;

}



  > .card-text:empty, > p:empty {

    margin: 0;

.output {

    margin: 2rem 0;

}

.output div {

    padding-top: 16px;

    background-clip: border-box;

    border: 1px solid rgba(0, 0, 0, 0.125);

    border-radius: 0.25rem

}



/* details elements */

details {

    border: 1px solid $gray-200;

    border-radius: 4px;

    padding: .5em .5em;

    margin-bottom: 1em;

}



details > details {

  margin-top: 1em;

  margin-bottom: 0em;

}



summary {

    line-height: 1.2;

    font-weight: 500;

    padding: 0.5em;

    color: $primary;

}



details[open] > summary {

  margin-bottom: 1em;

}



details[open].normalmode{

  border: 0px solid $gray-200;

  border-radius: $border-radius;

  padding: 0em;

  margin: 0em;

}



.card-deck {

  margin-bottom: $card-group-margin * 2;

details[open].normalmode > summary{

 display: none;

}

assets/scss/_variables_project.scss

+2 −12
Original line number Diff line number Diff line
@@ -2,6 +2,8 @@ $primary: #6e49cb; 
$secondary: #fca121;

$success: #28a745;

$warning: #ffc107;

$important: #E24329;

$orange: #fd7e14;



$border-radius: .25rem;

$grid-gutter-width: 20px;
@@ -10,18 +12,6 @@ $display1-size: 4.5rem !default; 


$google_font_name: "Inter";



.deck-center {

  margin: 0 auto !important;

}



.card-padding {

  padding: 0em 2em !important;

}



.fyi-padding {

  padding-top: 2em !important;

}



.home-section-h {

  padding: 2em !important;

}