Usage docs (#501)
* Add setup and usage docs Signed-off-by: lucperkins <lucperkins@gmail.com> * Finish initial version of setup doc * Add YAML config file for CLI docs * Finish CLI shortcode Signed-off-by: lucperkins <lucperkins@gmail.com> * Fix scrolling on mobile Signed-off-by: lucperkins <lucperkins@gmail.com> * Finish first version of usage doc Signed-off-by: lucperkins <lucperkins@gmail.com> * Remove go install section, modify CSS for CLI docs, and fix typo Signed-off-by: lucperkins <lucperkins@gmail.com>
This commit is contained in:
@@ -4,7 +4,7 @@ function anchorJs() {
|
||||
icon: '#'
|
||||
}
|
||||
|
||||
anchors.add('.content h2, .content h3, .content h4');
|
||||
anchors.add('.cli h2, .content h2, .content h3, .content h4');
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
46
website/assets/sass/cli.sass
Normal file
46
website/assets/sass/cli.sass
Normal file
@@ -0,0 +1,46 @@
|
||||
=border
|
||||
border: 1px solid $grey-light
|
||||
|
||||
.cli
|
||||
+border
|
||||
padding: 1.25rem
|
||||
margin: 2rem 0
|
||||
overflow: scroll
|
||||
|
||||
&-title
|
||||
font-size: 1rem
|
||||
margin-bottom: 3rem
|
||||
font-family: $family-code
|
||||
|
||||
h2
|
||||
color: $primary
|
||||
|
||||
&-description
|
||||
font-size: 1.25rem
|
||||
|
||||
&-example
|
||||
background-color: $black
|
||||
padding: 1.25rem
|
||||
font-family: $family-code
|
||||
color: $white-bis
|
||||
font-size: 1.1rem
|
||||
margin: 1rem 0
|
||||
font-weight: 700
|
||||
|
||||
.dollar
|
||||
color: $primary
|
||||
|
||||
.flags
|
||||
color: $red
|
||||
|
||||
&-flags
|
||||
+border
|
||||
padding: 1rem
|
||||
overflow: scroll
|
||||
|
||||
.flag
|
||||
font-family: $family-code
|
||||
color: $primary
|
||||
|
||||
.arg
|
||||
color: $dark
|
||||
@@ -32,7 +32,7 @@ $link-hover: $dark
|
||||
$code: $primary
|
||||
|
||||
$family-sans-serif: "{{ $sansSerifFont }}", BlinkMacSystemFont, -apple-system, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif
|
||||
//$family-code: "{{ $monospaceFont }}", monospace
|
||||
$family-code: "{{ $monospaceFont }}", monospace
|
||||
$section-padding: 3rem 4rem
|
||||
|
||||
$navbar-height: 5rem
|
||||
@@ -53,6 +53,8 @@ $colors: mergeColorMaps(("twitter-blue": ($twitter-blue, $white), "slack-green":
|
||||
@import "bulma-dashboard/bulma-dashboard.sass"
|
||||
@import "bulma-toc/bulma-toc.sass"
|
||||
|
||||
@import "cli"
|
||||
|
||||
// Ensure sticky footer at the bottom of the page
|
||||
.page
|
||||
display: flex
|
||||
|
||||
Reference in New Issue
Block a user