[doc] Removed the Hugo assets for the old documentation site. Signed-off-by: Hugo McNally <hugo.mcnally@gmail.com>
diff --git a/site/docs/.gitignore b/site/docs/.gitignore deleted file mode 100644 index e69de29..0000000 --- a/site/docs/.gitignore +++ /dev/null
diff --git a/site/docs/assets/scss/_base.scss b/site/docs/assets/scss/_base.scss deleted file mode 100644 index a950d13..0000000 --- a/site/docs/assets/scss/_base.scss +++ /dev/null
@@ -1,109 +0,0 @@ - -// HTML & Body - -html { - /* - Explicitly set the font size to the typical browser default to work around a - bug in Chrome where <code> elements don't get the right font size when using - @font-size=1rem (https://bugs.chromium.org/p/chromium/issues/detail?id=833697) - */ - font-size: 16px; - scroll-behavior: smooth; -} - -body { - color: $white; - color: var(--text-white); - font-family: 'Ubuntu', sans-serif; - background: #9380BF; - background-image: linear-gradient(90deg, #4BC0C8 0%, #C779D0 50%, #FEAC5E 100%); - background-image: var(--rainbow); -} - -::selection { - background-color: #71DBE2; - color: #3D1067; -} - -// ----------------------------- -// Typography - -.h2 { - font-family: 'Livvic', sans-serif; - font-size: 3.125em; - line-height: 1.28; - font-weight: 300; - margin-bottom: 1.4em; - margin-top: 1.4em; -} - -.h3 { - font-size: 1.375em; - font-weight: 700; - margin-bottom: 0.6363em; -} - -.bodytext { - font-size: 1.125em; - line-height: 1.778; - - &--large { - font-size: 1.375em; - line-height: 1.636; - } -} - -.quote { - font-family: 'Livvic', sans-serif; - font-size: calc(2em + 1vw); - line-height: 1.28; - font-weight: 300; -} - -// ----------------------------- -// Buttons - -.btn { - display: inline-block; - background: $white; - background: var(--background); - border-radius: 0.3125em; - color: $medium-purple; - color: var(--text-second); - text-transform: uppercase; - font-weight: 400; - font-size: 1.375em; - line-height: 1; - letter-spacing: 0.136em; - padding: 0.636em 1em; - text-decoration: none; - transition: background 0.2s ease-out; - - &:hover, - &:focus { - background: lighten($medium-purple, 40%); - } - - &:focus { - outline: 1px dashed $dark-purple; - outline-offset: -0.3125em; - } -} - -// ----------------------------- -// A11y related classes - -button:focus:not(:focus-visible), -a:focus:not(:focus-visible) { - outline: 2px solid transparent; -} - -.sr-only:not(:focus):not(:active) { - clip: rect(0 0 0 0); - clip-path: inset(50%); - height: 1px; - overflow: hidden; - position: absolute; - white-space: nowrap; - width: 1px; -}
diff --git a/site/docs/assets/scss/_chroma.scss b/site/docs/assets/scss/_chroma.scss deleted file mode 100644 index 1f395ab..0000000 --- a/site/docs/assets/scss/_chroma.scss +++ /dev/null
@@ -1,174 +0,0 @@ -/* Colorful style (`hugo gen chromastyles --style=colorful`) */ -/* Changes: default background color */ -:not([data-user-color-scheme]), -[data-user-color-scheme='light'] { -/* Background */ .chroma { background-color: adjust-color($white, $lightness: -3%) } -/* Other */ .chroma .x { } -/* Error */ .chroma .err { color: #ff0000; background-color: #ffaaaa } -/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; } -/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; } -/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc } -/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } -/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } -/* Keyword */ .chroma .k { color: #008800; font-weight: bold } -/* KeywordConstant */ .chroma .kc { color: #008800; font-weight: bold } -/* KeywordDeclaration */ .chroma .kd { color: #008800; font-weight: bold } -/* KeywordNamespace */ .chroma .kn { color: #008800; font-weight: bold } -/* KeywordPseudo */ .chroma .kp { color: #003388; font-weight: bold } -/* KeywordReserved */ .chroma .kr { color: #008800; font-weight: bold } -/* KeywordType */ .chroma .kt { color: #333399; font-weight: bold } -/* Name */ .chroma .n { } -/* NameAttribute */ .chroma .na { color: #0000cc } -/* NameBuiltin */ .chroma .nb { color: #007020 } -/* NameBuiltinPseudo */ .chroma .bp { } -/* NameClass */ .chroma .nc { color: #bb0066; font-weight: bold } -/* NameConstant */ .chroma .no { color: #003366; font-weight: bold } -/* NameDecorator */ .chroma .nd { color: #555555; font-weight: bold } -/* NameEntity */ .chroma .ni { color: #880000; font-weight: bold } -/* NameException */ .chroma .ne { color: #ff0000; font-weight: bold } -/* NameFunction */ .chroma .nf { color: #0066bb; font-weight: bold } -/* NameFunctionMagic */ .chroma .fm { } -/* NameLabel */ .chroma .nl { color: #997700; font-weight: bold } -/* NameNamespace */ .chroma .nn { color: #0e84b5; font-weight: bold } -/* NameOther */ .chroma .nx { } -/* NameProperty */ .chroma .py { } -/* NameTag */ .chroma .nt { color: #007700 } -/* NameVariable */ .chroma .nv { color: #996633 } -/* NameVariableClass */ .chroma .vc { color: #336699 } -/* NameVariableGlobal */ .chroma .vg { color: #dd7700; font-weight: bold } -/* NameVariableInstance */ .chroma .vi { color: #3333bb } -/* NameVariableMagic */ .chroma .vm { } -/* Literal */ .chroma .l { } -/* LiteralDate */ .chroma .ld { } -/* LiteralString */ .chroma .s { background-color: #fff0f0 } -/* LiteralStringAffix */ .chroma .sa { background-color: #fff0f0 } -/* LiteralStringBacktick */ .chroma .sb { background-color: #fff0f0 } -/* LiteralStringChar */ .chroma .sc { color: #0044dd; background-color: #fff0f0 } -/* LiteralStringDelimiter */ .chroma .dl { background-color: #fff0f0 } -/* LiteralStringDoc */ .chroma .sd { color: #dd4422; background-color: #fff0f0 } -/* LiteralStringDouble */ .chroma .s2 { background-color: #fff0f0 } -/* LiteralStringEscape */ .chroma .se { color: #666666; background-color: #fff0f0; font-weight: bold } -/* LiteralStringHeredoc */ .chroma .sh { background-color: #fff0f0 } -/* LiteralStringInterpol */ .chroma .si { background-color: #eeeeee } -/* LiteralStringOther */ .chroma .sx { color: #dd2200; background-color: #fff0f0 } -/* LiteralStringRegex */ .chroma .sr { color: #000000; background-color: #fff0ff } -/* LiteralStringSingle */ .chroma .s1 { background-color: #fff0f0 } -/* LiteralStringSymbol */ .chroma .ss { color: #aa6600; background-color: #fff0f0 } -/* LiteralNumber */ .chroma .m { color: #6600ee; font-weight: bold } -/* LiteralNumberBin */ .chroma .mb { color: #6600ee; font-weight: bold } -/* LiteralNumberFloat */ .chroma .mf { color: #6600ee; font-weight: bold } -/* LiteralNumberHex */ .chroma .mh { color: #005588; font-weight: bold } -/* LiteralNumberInteger */ .chroma .mi { color: #0000dd; font-weight: bold } -/* LiteralNumberIntegerLong */ .chroma .il { color: #6600ee; font-weight: bold } -/* LiteralNumberOct */ .chroma .mo { color: #4400ee; font-weight: bold } -/* Operator */ .chroma .o { color: #333333 } -/* OperatorWord */ .chroma .ow { color: #000000; font-weight: bold } -/* Punctuation */ .chroma .p { } -/* Comment */ .chroma .c { color: #888888 } -/* CommentHashbang */ .chroma .ch { color: #888888 } -/* CommentMultiline */ .chroma .cm { color: #888888 } -/* CommentSingle */ .chroma .c1 { color: #888888 } -/* CommentSpecial */ .chroma .cs { color: #cc0000; font-weight: bold } -/* CommentPreproc */ .chroma .cp { color: #557799 } -/* CommentPreprocFile */ .chroma .cpf { color: #557799 } -/* Generic */ .chroma .g { } -/* GenericDeleted */ .chroma .gd { color: #a00000 } -/* GenericEmph */ .chroma .ge { font-style: italic } -/* GenericError */ .chroma .gr { color: #ff0000 } -/* GenericHeading */ .chroma .gh { color: #000080; font-weight: bold } -/* GenericInserted */ .chroma .gi { color: #00a000 } -/* GenericOutput */ .chroma .go { color: #888888 } -/* GenericPrompt */ .chroma .gp { color: #c65d09; font-weight: bold } -/* GenericStrong */ .chroma .gs { font-weight: bold } -/* GenericSubheading */ .chroma .gu { color: #800080; font-weight: bold } -/* GenericTraceback */ .chroma .gt { color: #0044dd } -/* GenericUnderline */ .chroma .gl { text-decoration: underline } -/* TextWhitespace */ .chroma .w { color: #bbbbbb } -} - -/* Dracula style (`hugo gen chromastyles --style=dracula`) */ -/* Changes: default background color */ -[data-user-color-scheme='dark'] { -/* Background */ .chroma { color: #f8f8f2; background-color: adjust-color($black, $lightness: 3%) } -/* Other */ .chroma .x { } -/* Error */ .chroma .err { } -/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; } -/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; } -/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc } -/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } -/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } -/* Keyword */ .chroma .k { color: #ff79c6 } -/* KeywordConstant */ .chroma .kc { color: #ff79c6 } -/* KeywordDeclaration */ .chroma .kd { color: #8be9fd; font-style: italic } -/* KeywordNamespace */ .chroma .kn { color: #ff79c6 } -/* KeywordPseudo */ .chroma .kp { color: #ff79c6 } -/* KeywordReserved */ .chroma .kr { color: #ff79c6 } -/* KeywordType */ .chroma .kt { color: #8be9fd } -/* Name */ .chroma .n { } -/* NameAttribute */ .chroma .na { color: #50fa7b } -/* NameBuiltin */ .chroma .nb { color: #8be9fd; font-style: italic } -/* NameBuiltinPseudo */ .chroma .bp { } -/* NameClass */ .chroma .nc { color: #50fa7b } -/* NameConstant */ .chroma .no { } -/* NameDecorator */ .chroma .nd { } -/* NameEntity */ .chroma .ni { } -/* NameException */ .chroma .ne { } -/* NameFunction */ .chroma .nf { color: #50fa7b } -/* NameFunctionMagic */ .chroma .fm { } -/* NameLabel */ .chroma .nl { color: #8be9fd; font-style: italic } -/* NameNamespace */ .chroma .nn { } -/* NameOther */ .chroma .nx { } -/* NameProperty */ .chroma .py { } -/* NameTag */ .chroma .nt { color: #ff79c6 } -/* NameVariable */ .chroma .nv { color: #8be9fd; font-style: italic } -/* NameVariableClass */ .chroma .vc { color: #8be9fd; font-style: italic } -/* NameVariableGlobal */ .chroma .vg { color: #8be9fd; font-style: italic } -/* NameVariableInstance */ .chroma .vi { color: #8be9fd; font-style: italic } -/* NameVariableMagic */ .chroma .vm { } -/* Literal */ .chroma .l { } -/* LiteralDate */ .chroma .ld { } -/* LiteralString */ .chroma .s { color: #f1fa8c } -/* LiteralStringAffix */ .chroma .sa { color: #f1fa8c } -/* LiteralStringBacktick */ .chroma .sb { color: #f1fa8c } -/* LiteralStringChar */ .chroma .sc { color: #f1fa8c } -/* LiteralStringDelimiter */ .chroma .dl { color: #f1fa8c } -/* LiteralStringDoc */ .chroma .sd { color: #f1fa8c } -/* LiteralStringDouble */ .chroma .s2 { color: #f1fa8c } -/* LiteralStringEscape */ .chroma .se { color: #f1fa8c } -/* LiteralStringHeredoc */ .chroma .sh { color: #f1fa8c } -/* LiteralStringInterpol */ .chroma .si { color: #f1fa8c } -/* LiteralStringOther */ .chroma .sx { color: #f1fa8c } -/* LiteralStringRegex */ .chroma .sr { color: #f1fa8c } -/* LiteralStringSingle */ .chroma .s1 { color: #f1fa8c } -/* LiteralStringSymbol */ .chroma .ss { color: #f1fa8c } -/* LiteralNumber */ .chroma .m { color: #bd93f9 } -/* LiteralNumberBin */ .chroma .mb { color: #bd93f9 } -/* LiteralNumberFloat */ .chroma .mf { color: #bd93f9 } -/* LiteralNumberHex */ .chroma .mh { color: #bd93f9 } -/* LiteralNumberInteger */ .chroma .mi { color: #bd93f9 } -/* LiteralNumberIntegerLong */ .chroma .il { color: #bd93f9 } -/* LiteralNumberOct */ .chroma .mo { color: #bd93f9 } -/* Operator */ .chroma .o { color: #ff79c6 } -/* OperatorWord */ .chroma .ow { color: #ff79c6 } -/* Punctuation */ .chroma .p { } -/* Comment */ .chroma .c { color: #6272a4 } -/* CommentHashbang */ .chroma .ch { color: #6272a4 } -/* CommentMultiline */ .chroma .cm { color: #6272a4 } -/* CommentSingle */ .chroma .c1 { color: #6272a4 } -/* CommentSpecial */ .chroma .cs { color: #6272a4 } -/* CommentPreproc */ .chroma .cp { color: #ff79c6 } -/* CommentPreprocFile */ .chroma .cpf { color: #ff79c6 } -/* Generic */ .chroma .g { } -/* GenericDeleted */ .chroma .gd { color: #8b080b } -/* GenericEmph */ .chroma .ge { text-decoration: underline } -/* GenericError */ .chroma .gr { } -/* GenericHeading */ .chroma .gh { font-weight: bold } -/* GenericInserted */ .chroma .gi { font-weight: bold } -/* GenericOutput */ .chroma .go { color: #44475a } -/* GenericPrompt */ .chroma .gp { } -/* GenericStrong */ .chroma .gs { } -/* GenericSubheading */ .chroma .gu { font-weight: bold } -/* GenericTraceback */ .chroma .gt { } -/* GenericUnderline */ .chroma .gl { text-decoration: underline } -/* TextWhitespace */ .chroma .w { } -}
diff --git a/site/docs/assets/scss/_footer.scss b/site/docs/assets/scss/_footer.scss deleted file mode 100644 index 7d6942f..0000000 --- a/site/docs/assets/scss/_footer.scss +++ /dev/null
@@ -1,110 +0,0 @@ -.footer { - background: $white; - background: var(--background); - color: $medium-purple; - color: var(--text-second); - text-align: center; - padding: 2em $m-s 4.375em; - border-top: 1px solid; - - .ani-logo { - display: inline-block; - width: 4.375em; - height: 4.375em; - margin-bottom: 2.625em; - - .item { - fill: $dark-purple; - fill: var(--text-color); - } - } - - &:hover .ani-logo { - animation: rotate 1.5s ease-in-out; - .item { - animation: trans 0.6s ease-out both alternate 2; - - - &.right, - &.left { - animation: shrinkx 1.5s ease-in-out; - } - &.top, - &.bottom { - animation: shrinky 1.5s ease-in-out; - } - } - } - - a { - color: inherit; - - &:hover, - &:focus { - text-decoration: none; - } - - &:focus { - outline: 1px dashed $dark-purple; - outline-offset: 0.3em; - } - } -} - -.footer-nav { - margin-bottom: 0.375em; - - &__list { - display: inline-flex; - color: $dark-purple; - color: var(--text-color); - flex-wrap: wrap; - justify-content: center - } - - &__item { - margin: 0 1em 0.5em;; - - &--icons { - display: flex; - - > * { - padding: 0 0.3em; - } - } - - a { - font-weight: 700; - font-size: 1.5em; - text-decoration: none; - color: inherit; - display: block; - position: relative; - - &:after { - content: ""; - position: absolute; - left: 0; - bottom: 0; - right: 0; - height: 3px; - background: $dark-purple; - background: var(--text-color); - transform: scaleX(0); - transition: transform 0.4s ease-in-out; - will-change: transform; - } - - &:hover:after { - transform: scaleX(1); - transition-timing-function: cubic-bezier(.21,1.45,.51,1) - } - - &:focus { - outline: 1px dashed $dark-purple; - outline-offset: 0.3em; - } - } - } -} -
diff --git a/site/docs/assets/scss/_highlight.scss b/site/docs/assets/scss/_highlight.scss deleted file mode 100644 index df43555..0000000 --- a/site/docs/assets/scss/_highlight.scss +++ /dev/null
@@ -1,3 +0,0 @@ -.highlight { - line-height: normal; -}
diff --git a/site/docs/assets/scss/_intro.scss b/site/docs/assets/scss/_intro.scss deleted file mode 100644 index c5b8d68..0000000 --- a/site/docs/assets/scss/_intro.scss +++ /dev/null
@@ -1,130 +0,0 @@ -.intro { - background-image: url(../img/bg-intro.svg); - background-size: 140em 23em; - background-position: center bottom -1em; - background-repeat: repeat-x; - padding: 3em $m-s 13.75em; - - &__content { - max-width: $max-width-m; - margin: 0 auto; - display: flex; - align-items: center; - justify-content: flex-end; - min-height: 24em; - position: relative; - } - - &__body { - font-size: 1.75em; - line-height: 1.5714; - font-family: 'Livvic', sans-serif; - max-width: 45ch; - font-weight: 300; - position: relative; - z-index: 2; - } - - &__logo { - width: 22.75em; - height: 22.75em; - opacity: 0.3; - position: absolute; - top: 0.625em; - left: 50%; - transform: translateX(-27.1em); - } - - &:not(.animate):hover .ani-logo, - &.animate .ani-logo { - animation: rotate 2s ease-in-out; - .item { - animation: trans 0.8s ease-out both alternate 2; - - &.right, - &.left { - animation: shrinkx 2s ease-in-out; - } - &.top, - &.bottom { - animation: shrinky 2s ease-in-out; - } - } - } -} - -.ani-logo { - .item { - fill: #03043E; - opacity: 1; - will-change: transform; - } - - .ul { transform: translate(-7px, -7px); } - .ur { transform: translate(7px, -7px); } - .lr { transform: translate(7px, 7px); } - .ll { transform: translate(-7px, 7px); } - - .top { - transform: scaleY(1); - transform-origin: 41px 24px; - } - .right { - transform: scaleX(1); - transform-origin: 58px 41px; - } - .bottom { - transform: scaleY(1); - transform-origin: 41px 58px; - } - .left { - transform: scaleX(1); - transform-origin: 24px 41px; - } -} - -@media (prefers-reduced-motion: reduce) { - .item { - animation: none!important; - } -} - -@keyframes rotate { - 0% { - transform: rotate(0) scale(1); - } - 60% { - transform: rotate(0) scale(0.6); - } - 70% { - transform: rotate(90deg) scale(0.6); - animation-timing-function: cubic-bezier(.21,1.85,.72,1); - } - 100% { - transform: rotate(90deg) scale(1); - } -} - -@keyframes trans { - 50%, 100% { transform: none; } -} - -@keyframes shrinkx { - 0%, 80% { - transform: none; - } - - 15%, 70% { - transform: scaleX(0); - } -} - -@keyframes shrinky { - 0%, 80% { - transform: none; - } - - 15%, 70% { - transform: scaleY(0); - } -}
diff --git a/site/docs/assets/scss/_layout.scss b/site/docs/assets/scss/_layout.scss deleted file mode 100644 index a27b406..0000000 --- a/site/docs/assets/scss/_layout.scss +++ /dev/null
@@ -1,6 +0,0 @@ -.layout { - display: flex; - flex-wrap: wrap; - max-width: $max-width-l; - margin: 0 auto; -}
diff --git a/site/docs/assets/scss/_main-header.scss b/site/docs/assets/scss/_main-header.scss deleted file mode 100644 index 110f94c..0000000 --- a/site/docs/assets/scss/_main-header.scss +++ /dev/null
@@ -1,123 +0,0 @@ -.skip-link { - position: fixed; - top: -30em; - left: 0; - right: 0; - z-index: 20; - background: $white;; - color: $dark-purple; - padding: .5em 1em; - font-size: 1em; - text-align: center; - transition: top .1s linear; - text-decoration: none; - - &:focus, - &:focus-visible { - top: 0; - color: $dark-purple; - } -} - -.main-header { - margin: 0 auto; - // max-width: $max-width-m; - max-width: $max-width-l; - padding: 1.75em $m-s; - display: flex; - justify-content: space-between; - align-items: center; - flex-wrap: wrap; - - &:after { - content: ""; - display: block; - flex-grow: 9999; - height: 1em; - order: 2; - flex-basis: calc((40em - 100%) * 999); - } -} - -@media print { - .skip-link, .main-header { - display: none; - } -} - -.logo { - font-size: 1em; - width: 12.5em; - max-height: 2.375em; - min-width: 12.5em; - order: 1; - flex-grow: 1; - flex-basis: calc((40em - 100%) * 999); - - svg { - width: 12.5em; - height: 2.375em; - display: block; - margin: 0 auto; - } - - a { - display: block; - &:focus { - outline: 1px dashed $white; - outline-offset: 0.5em; - } - } -} - -.main-nav { - order: 3; - flex-grow: 1; - flex-basis: calc((40em - 100%) * 999); - - &__list { - display: flex; - justify-content: center; - } - - &__item { - & + & { - margin-left: 2em; - } - - a { - color: $white; - color: var(--text-white); - text-decoration: none; - font-weight: 700; - font-size: 1.125em; - display: block; - position: relative; - padding: 0.25em 0; - - &:after { - content: ""; - position: absolute; - left: 0; - bottom: 0; - right: 0; - height: 3px; - background: $white; - background: var(--text-white); - transform: scaleX(0); - transition: transform 0.4s ease-in-out; - will-change: transform; - } - - &:hover:after { - transform: scaleX(1); - transition-timing-function: cubic-bezier(.21,1.45,.51,1) - } - - &:focus { - outline: 1px dashed $white; - outline-offset: 0.3em; - } - } - } -}
diff --git a/site/docs/assets/scss/_markdown.scss b/site/docs/assets/scss/_markdown.scss deleted file mode 100644 index 7b3b956..0000000 --- a/site/docs/assets/scss/_markdown.scss +++ /dev/null
@@ -1,178 +0,0 @@ -.markdown { - flex-grow: 999; - flex-basis: 10em; - min-width: 65%; - max-width: 100%; - overflow-x: auto; - padding: $m-s; - line-height: 1.778; - - > * + * { - margin-top: 1em; - } - - h1 { - padding-top: 0.5em; - font-family: 'Livvic', sans-serif; - font-size: 2.5em; - line-height: 1.28; - font-weight: 300; - margin-bottom: .4em; - - &:first-child { - border-top: none; - padding-top: 0; - } - } - - h1.title { - font-size: 2.5em; - border: none !important; - font-family: 'Ubuntu', sans-serif !important; - font-weight: bold !important; - } - - h2 { - font-size: 1.375em; - font-weight: 700; - margin-bottom: 0.6363em; - } - - h3 { - font-size: 1.1em; - font-weight: 700; - margin-bottom: 0.5em; - } - - .header-link { - text-decoration: none; - } - - .header-link:hover, - .header-link:active { - text-decoration: underline; - } - - p { - @extend .bodytext; - font-size: inherit; - } - - blockquote { - padding-left: 2em; - } - - a { - color: $dark-purple; - color: var(--text-color); - - &:hover, - &:focus { - text-decoration: none; - } - - &:focus { - outline: 1px dashed; - outline-offset: 0.3em; - } - } - - img, svg { - max-width: 100%; - background: #fff; - } - - table { - max-width: 100%; - overflow: hidden; - border-collapse: collapse; - - td, th { - vertical-align: top; - border: 1px solid var(--text-second); - padding: 0.5em; - } - - th { - font-weight: bold; - } - } - - pre { - width: 100%; - overflow-x: auto; - display: block; - white-space: pre-wrap; - padding: 0.5em; - } - - ul, ol { - padding-left: 1em; - - > li + li { - margin-top: 0.5em; - } - - ul, - ol { - margin-top: 0.5em; - } - } -} - -.overflow-table { - width: 100%; - overflow-x: auto; -} - -.regpic { - width: 100%; -} - -table.regdef { - border: 2px solid $dark-purple; - border: 2px solid var(--text-color); -} - -// Dashboard design -table.hw-project-dashboard { - thead th { - vertical-align: middle; - } - - td { - vertical-align: middle; - - &.dv-doc, &.version { - text-align: center; - } - - &.hw-stage { - text-align: center; - border-style: solid none; - } - } -} - -/* Callouts */ -.bd-callout { - padding: 1.25rem; - margin-top: 1.25rem; - margin-bottom: 1.25rem; - border: 1px solid #eee; - border-left-color: rgb(238, 238, 238); - border-left-width: 1px; - border-left-width: .25rem; - border-radius: .25rem; -} - -.bd-callout h5 { - font-size: 1.25em; - margin:0; -} -.bd-callout-warning { - border-left-color: #f0ad4e; -} -.bd-callout p:last-child { - margin-bottom: 0; -}
diff --git a/site/docs/assets/scss/_menu.scss b/site/docs/assets/scss/_menu.scss deleted file mode 100644 index 3d46de5..0000000 --- a/site/docs/assets/scss/_menu.scss +++ /dev/null
@@ -1,71 +0,0 @@ -.menu { - width: 17em; - flex-grow: 1; - flex-shrink: 0; - padding: $m-s; - font-size: 1em; - border-right: 1px solid $medium-purple; - border-right: 1px solid var(--text-second); - - > ul > li { - font-size: 0.875em; - font-family: 'Ubuntu', sans-serif; - margin-top: 1em; - display: block; - } - - > ul > li > ul li { - margin-left: 1em; - margin-top: 0.75em; - } - - ul { - list-style-type: none; - padding: 0; - margin-bottom: 1.25em; - } - - a { - color: $dark-purple; - color: var(--text-color); - line-height: 1.2; - - &:hover, - &:focus { - color: var(--text-second); - text-decoration: underline; - } - - &:focus { - outline: 1px dashed; - outline-offset: 0.3em; - } - } - - a.active { - font-weight: bold; - } - - ul.parent { - display: none; - } - - ul.ancestor { - display: block; - } - - a.section { - text-decoration: underline; - } - - a.ancestor { - text-decoration: underline; - } - -} - -@media print, only screen and (max-width: 65rem) { - .menu { - display: none; - } -}
diff --git a/site/docs/assets/scss/_parents.scss b/site/docs/assets/scss/_parents.scss deleted file mode 100644 index dc94815..0000000 --- a/site/docs/assets/scss/_parents.scss +++ /dev/null
@@ -1,43 +0,0 @@ -.parents { - font-size: 1em; - - li { - font-family: 'Ubuntu', sans-serif; - font-size: 0.875em; - font-weight: bold; - margin-left: 1em; - margin-right: 0.4em; - margin-top: 1em; - } - - ul { - overflow: hidden; - display: flex; - flex-direction: row-reverse; - justify-content: flex-end; - } - - a { - color: $dark-purple; - color: var(--text-color); - display: block; - text-decoration: none; - - &:hover, - &:focus { - text-decoration: underline; - } - - &:focus { - outline: 1px dashed; - outline-offset: 0.3em; - } - } - -} - -@media print { - .parents { - display: none; - } -}
diff --git a/site/docs/assets/scss/_reset.scss b/site/docs/assets/scss/_reset.scss deleted file mode 100644 index 12c140c..0000000 --- a/site/docs/assets/scss/_reset.scss +++ /dev/null
@@ -1,78 +0,0 @@ -/* Box sizing rules */ -*, -*::before, -*::after { - box-sizing: border-box; -} - -/* Remove default padding */ -ul[class], -ol[class] { - padding: 0; -} - -/* Remove default margin */ -body, -h1, -h2, -h3, -h4, -p, -ul[class], -ol[class], -li, -figure, -figcaption, -blockquote, -dl, -dd { - margin: 0; -} - -/* Set core body defaults */ -body { - min-height: 100vh; - scroll-behavior: smooth; - text-rendering: optimizeSpeed; - line-height: 1.5; -} - -/* Remove list styles on ul, ol elements with a class attribute */ -ul[class], -ol[class] { - list-style: none; -} - -/* A elements that don't have a class get default styles */ -a:not([class]) { - text-decoration-skip-ink: auto; -} - -/* Make images easier to work with */ -img { - max-width: 100%; - display: block; -} - -/* Natural flow and rhythm in articles by default */ -article>*+* { - margin-top: 1em; -} - -/* Inherit fonts for inputs and buttons */ -input, -button, -textarea, -select { - font: inherit; -} - -/* Remove all animations and transitions for people that prefer not to see them */ -@media (prefers-reduced-motion: reduce) { - * { - animation-duration: 0.01ms !important; - animation-iteration-count: 1 !important; - transition-duration: 0.01ms !important; - scroll-behavior: auto !important; - } -}
diff --git a/site/docs/assets/scss/_scheme-toggle.scss b/site/docs/assets/scss/_scheme-toggle.scss deleted file mode 100644 index d09edae..0000000 --- a/site/docs/assets/scss/_scheme-toggle.scss +++ /dev/null
@@ -1,41 +0,0 @@ -.no-js .user-toggle { - display: none; -} - -.user-toggle { - margin-left: 1.5em; - - button { - background: transparent; - border: none; - display: block; - color: #FFF; - color: var(--text-white); - vertical-align: middle; - padding: 0; - margin-top: 0.25em; - height: 1.6875em; - cursor: pointer; - - svg { - width: 1.5em; - height: 1.5em; - display: block; - transition: transform 1s cubic-bezier(.18,1.64,.66,.94); - } - &:focus, - &:active { - outline: none; - } - - &:hover svg, - &:focus svg { - transform: rotate(540deg); - } - - &:focus svg { - outline: 1px dashed; - outline-offset: 0.3em; - } - } -}
diff --git a/site/docs/assets/scss/_sectioncontent.scss b/site/docs/assets/scss/_sectioncontent.scss deleted file mode 100644 index 0dae2f3..0000000 --- a/site/docs/assets/scss/_sectioncontent.scss +++ /dev/null
@@ -1,5 +0,0 @@ -.sectioncontent { - li { - list-style-type: none; - } -}
diff --git a/site/docs/assets/scss/_sections.scss b/site/docs/assets/scss/_sections.scss deleted file mode 100644 index bc3201e..0000000 --- a/site/docs/assets/scss/_sections.scss +++ /dev/null
@@ -1,12 +0,0 @@ -.light-bg { - background: $white; - color: $dark-purple; - background: var(--background); - color: var(--text-color); - - .bodytext { - transition: color 0.5s ease; - } - - transition: color 0.2s ease; -}
diff --git a/site/docs/assets/scss/_toc.scss b/site/docs/assets/scss/_toc.scss deleted file mode 100644 index 0b97d22..0000000 --- a/site/docs/assets/scss/_toc.scss +++ /dev/null
@@ -1,73 +0,0 @@ -.toc { - width: 15em; - height: 100%; - flex-grow: 1; - flex-shrink: 0; - padding: $m-s; - font-size: 1em; - position: -webkit-sticky; - position: sticky; - top: 0; - border-left: 1px solid $medium-purple; - border-left: 1px solid var(--text-second); - - > nav > ul { - font-size: 1em; - font-weight: normal; - } - - > nav > ul ul { - font-weight: bold; - font-size: 0.875em; - margin-top: 0.75em; - - a { - text-transform: none; - } - } - - > nav > ul > li > a { - text-transform: uppercase; - font-size: 0.875em; - font-weight: bold; - font-family: 'Ubuntu', sans-serif; - margin-top: 1em; - display: block; - } - - ul { - list-style-type: none; - padding: 0; - margin-bottom: 1.25em; - } - - li { - margin-bottom: 0.75em; - } - - a { - color: $dark-purple; - color: var(--text-color); - display: block; - text-decoration: none; - line-height: 1.2; - text-transform: uppercase; - - &:hover, - &:focus { - text-decoration: underline; - } - - &:focus { - outline: 1px dashed; - outline-offset: 0.3em; - } - } - -} - -@media print, only screen and (max-width: 50rem) { - .toc { - display: none; - } -}
diff --git a/site/docs/assets/scss/_variables.scss b/site/docs/assets/scss/_variables.scss deleted file mode 100644 index 6425d18..0000000 --- a/site/docs/assets/scss/_variables.scss +++ /dev/null
@@ -1,90 +0,0 @@ -$white: #fff; -$black: #1D0037; -$dark-purple: #3D1067; -$medium-purple: #68688B; -$blue: #1683B5; - -$max-width-xl: 90rem; -$max-width-l: 99.25rem; -$max-width-m: 65.75rem; -$max-width-s: 52rem; -$m-s: calc(1em + 1vw); - -:root { - --color-mode: 'light'; - --white: #fff; - --black: #1D0037; - --dark-purple: #3D1067; - --medium-purple: #68688B; - --light-purple: #ccbbff; - --blue: #1683B5; - --filter-dark: invert(100%) grayscale(100%) brightness(120%); - --filter-light: none; - --rainbow-light: linear-gradient(90deg, #4BC0C8 0%, #C779D0 50%, #FEAC5E 100%); - --rainbow-dark: linear-gradient(90deg, rgba(29,0,55,0.4), rgba(29,0,55,0.4) 100%), linear-gradient(90deg, #4BC0C8 0%, #C779D0 50%, #FEAC5E 100%); - --text-third: #1683B5; - - --background: var(--white); - --text-color: var(--black); - --text-second: var(--medium-purple); - --rainbow: var(--rainbow-light); - --text-white: var(--white); - --filter: var(--filter-light); -} - -@media (prefers-color-scheme: dark) { - :root { - --color-mode: 'dark'; - } - - :root:not([data-user-color-scheme]) { - --background: var(--black); - --text-color: var(--light-purple); - --text-second: #88a; - --rainbow: var(--rainbow-dark); - --text-white: rgba(255,255,255,0.8); - --filter: var(--filter-dark); - - .intro { - background-image: url(../img/dark/bg-intro.svg); - } - - .cta { - background-image: - url('../img/dark/quote-top.svg'), - url('../img/dark/quote-bottom.svg'); - } - .partner-quote { - background-image: url('data:image/svg+xml;utf8, - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 135 20">/ - <path fill="%23ccbbff" fill-rule="nonzero" d="M79 0a31 31 0 00-1.4 4c-.3 1-.5 2.2-.5 3.1 0 1.1.2 2 .5 2.9l.8 2.3c.3.7.5 1.6.5 2.6 0 1.3-.5 2.4-1.5 3.3-1 1-2.3 1.4-4 1.4-1.6 0-3-.5-3.9-1.5-1-1-1.4-2.5-1.4-4.4 0-1.3.3-2.7.9-4.4A27.5 27.5 0 0174.9 0H79zM66 0a31 31 0 00-1.5 4C64.2 5 64 6.1 64 7c0 1.1.2 2 .5 2.9l.9 2.3c.3.7.4 1.6.4 2.6 0 1.3-.5 2.4-1.5 3.3-1 1-2.3 1.4-4 1.4-1.6 0-3-.5-3.9-1.5-1-1-1.4-2.5-1.4-4.4 0-1.3.3-2.7.9-4.4a27.5 27.5 0 016-9.3h4zM35 9.6v2H0v-2h35zm100 0v2h-35v-2h35z"/>/ - </svg>'); - } - } -} - -[data-user-color-scheme='dark'] { - --background: var(--black); - --text-color: var(--light-purple); - --text-second: #88a; - --rainbow: var(--rainbow-dark); - --text-white: rgba(255,255,255,0.8); - --filter: var(--filter-dark); - - .intro { - background-image: url(../img/dark/bg-intro.svg); - } - - .cta { - background-image: - url('../img/dark/quote-top.svg'), - url('../img/dark/quote-bottom.svg'); - } - - .partner-quote { - background-image: url('data:image/svg+xml;utf8, - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 135 20">/ - <path fill="%23ccbbff" fill-rule="nonzero" d="M79 0a31 31 0 00-1.4 4c-.3 1-.5 2.2-.5 3.1 0 1.1.2 2 .5 2.9l.8 2.3c.3.7.5 1.6.5 2.6 0 1.3-.5 2.4-1.5 3.3-1 1-2.3 1.4-4 1.4-1.6 0-3-.5-3.9-1.5-1-1-1.4-2.5-1.4-4.4 0-1.3.3-2.7.9-4.4A27.5 27.5 0 0174.9 0H79zM66 0a31 31 0 00-1.5 4C64.2 5 64 6.1 64 7c0 1.1.2 2 .5 2.9l.9 2.3c.3.7.4 1.6.4 2.6 0 1.3-.5 2.4-1.5 3.3-1 1-2.3 1.4-4 1.4-1.6 0-3-.5-3.9-1.5-1-1-1.4-2.5-1.4-4.4 0-1.3.3-2.7.9-4.4a27.5 27.5 0 016-9.3h4zM35 9.6v2H0v-2h35zm100 0v2h-35v-2h35z"/>/ - </svg>'); - } -}
diff --git a/site/docs/assets/scss/style.scss b/site/docs/assets/scss/style.scss deleted file mode 100644 index 0ab4431..0000000 --- a/site/docs/assets/scss/style.scss +++ /dev/null
@@ -1,16 +0,0 @@ -@import "reset"; -@import "variables"; -@import "base"; -@import "main-header"; -@import "scheme-toggle"; -@import "sections"; -@import "layout"; -@import "toc"; -@import "markdown"; -@import "intro"; -@import "footer"; -@import "highlight"; -@import "menu"; -@import "chroma"; -@import "parents"; -@import "sectioncontent";
diff --git a/site/docs/config.toml b/site/docs/config.toml deleted file mode 100644 index dbcc111..0000000 --- a/site/docs/config.toml +++ /dev/null
@@ -1,90 +0,0 @@ -# Copyright lowRISC contributors. -# Licensed under the Apache License, Version 2.0, see LICENSE for details. -# SPDX-License-Identifier: Apache-2.0 - -# CAUTION: Use util/build_docs.py to generate the documentation site. There -# are pre-processing steps that are not yet integrated into the hugo-based -# build. - -assetDir = "site/docs/assets" -baseURL = "https://docs.opentitan.org" -disablePathToLower = true -disableLiveReload = true -contentDir = "../.." -resourceDir = "build/docs-resources" -ignoreFiles = [ - ".*\\.S$", - ".*\\.bin$", - ".*\\.c$", - ".*\\.cc$", - ".*\\.cmd$", - ".*\\.cfg$", - ".*\\.core$", - ".*\\.dat$", - ".*\\.do$", - ".*\\.el$", - ".*\\.f$", - ".*\\.h$", - ".*\\.hjson$", - ".*\\.ld$", - ".*\\.mak$", - ".*\\.md5$", - ".*\\.mk$", - ".*\\.mmi$", - ".*\\.o$", - ".*\\.patch$", - ".*\\.py$", - ".*\\.pyc$", - ".*\\.rsp$", - ".*\\.sh$", - ".*\\.sv$", - ".*\\.svh$", - ".*\\.tcl$", - ".*\\.tpl$", - ".*\\.txt$", - ".*\\.xdc$", - ".*\\.yml$", - ".*\\.clang-format$", - - # DO NOT remove README.md from this list. See issue #13345 for more details. - ".*README.md", - ".*CONTRIBUTING.md", - - "/__pycache__/.*", - "/bazel-.*/.*", - "/build/.*", - "/build-.*/.*", - "/ci/", - "/hw/vendor/.*", - "/hw/ip_templates/.*", - "/sw/vendor/.*", - "/opentitan-docs/", - "/scratch/", - "/site/.*", - "/util/doxygen/", - ".*/jgproject/.*", - ".*/verdiLog/.*", - "Makefile$", - "CLA", - "COMMITTERS", -] -disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"] -googleAnalytics = "UA-151030466-2" -staticDir = [ - # This is the generated software APIs - "build/docs-generated/sw/public-api", -] - -[params] -generatedRoot = "build/docs-generated" - -[markup] - [markup.highlight] - guessSyntax = true - noClasses = false - [markup.goldmark.renderer] - unsafe = true - [markup.tableOfContents] - startLevel = 1 - endLevel = 2 - ordered = false
diff --git a/site/docs/layouts/_default/list.html b/site/docs/layouts/_default/list.html deleted file mode 120000 index 4124bab..0000000 --- a/site/docs/layouts/_default/list.html +++ /dev/null
@@ -1 +0,0 @@ -single.html \ No newline at end of file
diff --git a/site/docs/layouts/_default/single.html b/site/docs/layouts/_default/single.html deleted file mode 100644 index 73329a0..0000000 --- a/site/docs/layouts/_default/single.html +++ /dev/null
@@ -1,30 +0,0 @@ -<!DOCTYPE html> -<html class="no-js"> - {{ partial "head.html" . }} - <body onload="WaveDrom.ProcessAll()"> - {{ partial "header.html" . }} - <section class="light-bg"> - <div class="layout"> - {{ partial "parents.html" . }} - </div> - <div class="layout"> - <aside> - {{ partial "menu.html" . }} - </aside> - <main id="main" role="main" class="markdown"> - {{ if .Title }}<h1 class="title">{{ .Title }}</h1>{{ end }} - <!-- The regex finds header tags and converts the content into a link - with a link icon appended. - --> - {{ .Content - | replaceRE "(<h[1-6] id=\"(.+)\".*>)(.*)(</h[1-6]>)" - `${1}<a class="header-link" href="#${2}">${3}</a>${4}` - | safeHTML - }} - </main> - {{ partial "toc.html" . }} - </div> - </section> - {{ partial "footer.html" . }} - </body> -</html>
diff --git a/site/docs/layouts/partials/footer.html b/site/docs/layouts/partials/footer.html deleted file mode 100644 index 14fa434..0000000 --- a/site/docs/layouts/partials/footer.html +++ /dev/null
@@ -1,119 +0,0 @@ -<footer id="footer" class="footer"> - <svg class="ani-logo" focusable="false" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 84 84"> - <g fill="none" fill-rule="evenodd"> - <rect class="center item" width="24" height="24" x="30" y="30" /> - <path class="ul item" d="M19 19h27v10.5c0 .8-.7 1.5-1.5 1.5H31v13.5c0 .8-.7 1.5-1.5 1.5H19V19z" /> - <path class="ll item" d="M19 65h27V54.5c0-.8-.7-1.5-1.5-1.5H31V39.5c0-.8-.7-1.5-1.5-1.5H19v27z" /> - <path class="ur item" d="M65 19H38v10.5c0 .8.7 1.5 1.5 1.5H53v13.5c0 .8.7 1.5 1.5 1.5H65V19z" /> - <path class="lr item" d="M65 65H38V54.5c0-.8.7-1.5 1.5-1.5H53V39.5c0-.8.7-1.5 1.5-1.5H65v27z" /> - <path class="right item item--outer" - d="M82.5 48c.8 0 1.5.7 1.5 1.5v9c0 .8-.7 1.5-1.5 1.5H69V48h13.5zm0-24c.8 0 1.5.7 1.5 1.5v9c0 .8-.7 1.5-1.5 1.5H69V24h13.5z" /> - <path class="left item item--outer" - d="M15 48v12H1.5C.7 60 0 59.3 0 58.5v-9c0-.8.7-1.5 1.5-1.5H15zm0-24v12H1.5C.7 36 0 35.3 0 34.5v-9c0-.8.7-1.5 1.5-1.5H15z" /> - <path class="top item item--outer" - d="M34.5 0c.8 0 1.5.7 1.5 1.5V15H24V1.5c0-.8.7-1.5 1.5-1.5h9zm24 0c.8 0 1.5.7 1.5 1.5V15H48V1.5c0-.8.7-1.5 1.5-1.5h9z" /> - <path class="bottom item item--outer" - d="M60 69v13.5c0 .8-.7 1.5-1.5 1.5h-9c-.8 0-1.5-.7-1.5-1.5V69h12zm-24 0v13.5c0 .8-.7 1.5-1.5 1.5h-9c-.8 0-1.5-.7-1.5-1.5V69h12z" /> - </g> - </svg> - - <nav class="footer-nav" aria-label="Full"> - <ul class="footer-nav__list"> - <li class="footer-nav__item"> - <a href="https://opentitan.org">Home</a> - </li> - <li class="footer-nav__item"> - <a href="https://docs.opentitan.org">Documentation</a> - </li> - <li class="footer-nav__item footer-nav__item--icons"> - <a href="https://github.com/lowRISC/opentitan" aria-label="View on Github"> - <svg focusable="false" width="24" height="20" viewBox="0 0 24 20"> - <path fill="currentColor" fill-rule="evenodd" - d="M11.4 1A9 9 0 002 10c0 4.2 2.7 7.7 6.5 9 .5 0 .7-.2.7-.5v-2.2s-2.7.5-3.3-1.2c0 0-.4-1-1-1.3 0 0-1-.6 0-.6 0 0 1 0 1.5 1 .8 1.4 2.2 1 2.8.7 0-.6.3-1 .6-1.2-2.1-.2-4.3-.5-4.3-4.1 0-1 .3-1.6.9-2.2C6.3 7 6 6 6.5 4.9c.8-.3 2.6 1 2.6 1a9.3 9.3 0 014.9 0s1.8-1.3 2.6-1c.6 1.2.2 2.2.1 2.5.6.6 1 1.2 1 2.2 0 3.6-2.2 3.9-4.4 4 .4.4.7 1 .7 1.8v3.1c0 .3.1.6.6.5a9.3 9.3 0 006.5-9c0-5-4.4-9-9.7-9z" /> - </svg> - </a> - </li> - </ul> - </nav> - - <p>© 2019 – {{ now.Format "2006" }} <a href="https://www.lowrisc.org">lowRISC</a> contributors, <a - href="https://opentitan.org/usage-policy/">Usage Policy</a>, <a - href="https://opentitan.org/privacy-policy/">Privacy Policy</a>.</p> - <p>No license is granted for the OpenTitan logo or other trademarks. <a - href="https://opentitan.org/trademark-usage-policy/">Trademark Usage - Policy</a>.</p> -</footer> - -<script type="text/javascript" id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> -<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/2.1.2/skins/default.js"></script> -<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/2.1.2/wavedrom.js"></script> -<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/markdown-it/10.0.0/markdown-it.min.js"></script> - -<script> - // Wrap tables - const tables = document.getElementsByTagName('table'); - for (let i = 0; i < tables.length; i++) { - const table = tables[i]; - const wrapper = document.createElement('div'); - wrapper.setAttribute('class', 'overflow-table'); - table.parentNode.insertBefore(wrapper, table); - wrapper.appendChild(table); - } - - // Dark and light theme - document.documentElement.classList.remove('no-js'); - const STORAGE_KEY = 'user-color-scheme'; - const COLOR_MODE_KEY = '--color-mode'; - - const modeToggleButton = document.querySelector('.js-mode-toggle'); - - const getCSSCustomProp = propKey => { - let response = getComputedStyle(document.documentElement).getPropertyValue(propKey); - - if (response.length) { - response = response.replace(/\"/g, '').trim(); - } - - return response; - }; - - const applySetting = passedSetting => { - let currentSetting = passedSetting || localStorage.getItem(STORAGE_KEY); - - if (currentSetting) { - document.documentElement.setAttribute('data-user-color-scheme', currentSetting) - } - }; - - const toggleSetting = () => { - let currentSetting = localStorage.getItem(STORAGE_KEY); - - switch (currentSetting) { - case null: - currentSetting = getCSSCustomProp(COLOR_MODE_KEY) === 'dark' ? 'light' : 'dark'; - break; - case 'light': - currentSetting = 'dark'; - break; - case 'dark': - currentSetting = 'light'; - break; - } - - localStorage.setItem(STORAGE_KEY, currentSetting); - - return currentSetting; - }; - - modeToggleButton.addEventListener('click', evt => { - evt.preventDefault(); - - applySetting(toggleSetting()); - }); - - applySetting(); - - - - -</script>
diff --git a/site/docs/layouts/partials/gtag.html b/site/docs/layouts/partials/gtag.html deleted file mode 100644 index 6865da9..0000000 --- a/site/docs/layouts/partials/gtag.html +++ /dev/null
@@ -1,10 +0,0 @@ -{{ with .Site.GoogleAnalytics }} -<script async src="https://www.googletagmanager.com/gtag/js?id={{ . }}"></script> -<script> - window.dataLayer = window.dataLayer || []; - function gtag(){dataLayer.push(arguments);} - gtag('js', new Date()); - - gtag('config', '{{ . }}'); -</script> -{{ end }}
diff --git a/site/docs/layouts/partials/head.html b/site/docs/layouts/partials/head.html deleted file mode 100644 index 305cb42..0000000 --- a/site/docs/layouts/partials/head.html +++ /dev/null
@@ -1,30 +0,0 @@ -<head> - <meta charset="UTF-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <meta http-equiv="X-UA-Compatible" content="ie=edge"> - - <meta name="Description" content="{{ .Title }}"> - <meta property="og:title" content="{{ with .Title }}{{ . }} | {{ end }}OpenTitan Documentation"> - <meta property="twitter:title" content="{{ with .Title }}{{ . }} | {{ end }}OpenTitan Documentation"> - <meta property="og:image" content="https://opentitan.org/opentitan.png"> - <meta property="twitter:image:src" content="https://opentitan.org/opentitan.png"> - <meta property="og:image:width" content="1200"> - <meta property="og:image:height" content="630"> - <meta property="og:description" content="OpenTitan Documentation"> - <meta property="twitter:description" content="OpenTitan Documentation"> - <meta name="twitter:card" content="summary_large_image"> - - <link rel="apple-touch-icon" sizes="180x180" href="https://opentitan.org/apple-touch-icon.png"> - <link rel="icon" type="image/png" sizes="32x32" href="https://opentitan.org/favicon-32x32.png"> - <link rel="icon" type="image/png" sizes="16x16" href="https://opentitan.org/favicon-16x16.png"> - <link rel="shortcut icon" href="https://opentitan.org/favicon.ico"> - <meta name="msapplication-TileColor" content="#c27bcf"> - <meta name="theme-color" content="#ffffff"> - - <link href="https://fonts.googleapis.com/css?family=Livvic:300|Ubuntu:400,700&display=swap" rel="stylesheet"> - <title>{{ if .Title }}{{ .Title }} | {{ end }}OpenTitan Documentation</title> - {{ $options := (dict "targetPath" "css/style.css" "outputStyle" "compressed" "enableSourceMap" true) }} - {{ $style := resources.Get "scss/style.scss" | resources.ToCSS $options }} - <link rel="stylesheet" href="{{ $style.Permalink }}"> - {{ partial "gtag" . }} -</head>
diff --git a/site/docs/layouts/partials/header.html b/site/docs/layouts/partials/header.html deleted file mode 100644 index 9b97a7b..0000000 --- a/site/docs/layouts/partials/header.html +++ /dev/null
@@ -1,45 +0,0 @@ -<svg style="width: 0; height: 0; position: absolute; opacity: 0;"> - <defs> - <linearGradient id="a" x1="0%" x2="100%" y1="100%" y2="0%"> - <stop offset="0%" stop-color="#4BC0C8"/> - <stop offset="52.5%" stop-color="#C779D0"/> - <stop offset="100%" stop-color="#FEAC5E"/> - </linearGradient> - <path id="b" vector-effect="non-scaling-stroke" d="M61 127v30h31v39c0 2-2 4-5 4h-5v15H3v-79h14v-5c0-2 2-4 5-4h39zm135 0c2 0 4 2 4 4v5h14v79h-79v-15h-4c-2 0-4-2-4-4v-39h30v-30h39zM57 161H38v19h19v-19zm122 0h-18v19h18v-19zm-35-87v69H75V74h69zm71-71v79h-15v5c0 3-2 5-4 5h-39V61h-30V22c0-3 2-5 4-5h5V3h79zM82 3v14h5c3 0 5 2 5 5v39H61v31H22c-3 0-5-2-5-5v-5H3V3h79zm79 54h19V38h-19v19zM57 57V38H38v19h19z"/> - <path id="c" vector-effect="non-scaling-stroke" d="M182 112v39h32c2 0 4 2 4 4v23c0 2-2 4-4 4h-32v32c0 2-2 4-4 4h-23c-2 0-4-2-4-4v-32h-39v-27c0-3 1-4 4-4h35v-35c0-3 1-4 4-4h27zm-119 0c2 0 4 1 4 3v36h35c3 0 4 1 4 3v28H67v32c0 2-2 4-4 4H40c-2 0-4-2-4-4v-32H4c-2 0-4-2-4-4v-23c0-2 2-4 4-4h32v-39h27zm77-34v62H78V78h62zM63 0c2 0 4 2 4 4v32h39v27c0 3-1 4-4 4H67v35c0 3-1 4-4 4H36V67H4c-2 0-4-2-4-4V40c0-2 2-4 4-4h32V4c0-2 2-4 4-4h23zm115 0c2 0 4 2 4 4v32h32c2 0 4 2 4 4v23c0 2-2 4-4 4h-32v39h-27c-2 0-4-1-4-3V67h-35c-3 0-4-1-4-3V36h39V4c0-2 2-4 4-4h23z"/> - <path id="d" vector-effect="non-scaling-stroke" d="M187 117v8h27c2 0 4 1 4 3v24c0 2-2 4-4 4h-27v31h-31v27c0 2-2 4-4 4h-24c-2 0-3-2-3-4v-27h-8v-27c0-2 2-4 4-4h35v-35c0-2 2-4 4-4h27zm-129 0c2 0 4 2 4 4v35h35c2 0 4 2 4 4v27h-8v27c0 2-1 4-3 4H66c-2 0-4-2-4-4v-27H31v-31H4c-2 0-4-2-4-4v-24c0-2 2-3 4-3h27v-8h27zm82-39v62H78V78h62zM90 0c2 0 3 2 3 4v27h8v27c0 2-2 4-4 4H62v35c0 2-2 4-4 4H31v-8H4c-2 0-4-1-4-3V66c0-2 2-4 4-4h27V31h31V4c0-2 2-4 4-4h24zm62 0c2 0 4 2 4 4v27h31v31h27c2 0 4 2 4 4v24c0 2-2 3-4 3h-27v8h-27c-2 0-4-2-4-4V62h-35c-2 0-4-2-4-4V31h8V4c0-2 1-4 3-4h24z"/> - </defs> -</svg> - -<a href="#main" class="skip-link">Skip to main content</a> - -<header class="main-header"> - <h1 class="logo"> - <a href="/"> - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1068 200" aria-hidden="true" focusable="false"> - <g fill="#FFF" fill-rule="evenodd"> - <path d="M932.8 60.2v3.2c-6.6-5.9-15.4-9.3-26.4-9.3-20.5 0-38 15.2-41 38h24.4c1.5 0 2.8-.8 3.3-2.2 3.1-7.8 10.1-12.7 18.9-12.7 11 0 20.8 9 20.8 22 0 13.2-9.8 22-20.8 22-8.8 0-15.8-4.8-18.9-12.7a3.6 3.6 0 00-3.3-2.2h-24.5a41.6 41.6 0 0067.5 28.6v3.3c0 2 1.6 3.5 3.6 3.5h20c2 0 3.5-1.6 3.5-3.5v-78c0-2-1.6-3.5-3.5-3.5h-20c-2 0-3.6 1.6-3.6 3.5zm-524-4a40.6 40.6 0 00-33.2 15.4v-9.9c0-2-1.6-3.5-3.5-3.5h-5.8c-2 0-3.5 1.6-3.5 3.5v30.4h11c1.6 0 3-1 3.4-2.5A31.2 31.2 0 01438 100c0 19.9-14 32.4-31.2 32.4a31.2 31.2 0 01-30-23.4 3.6 3.6 0 00-3.5-2.7h-10.5V167c0 2 1.5 3.5 3.5 3.5h5.8c2 0 3.5-1.6 3.5-3.5v-38.5a40.6 40.6 0 0033.2 15.4 42 42 0 0041.7-43.9 42 42 0 00-41.7-43.8zm658 33.3v48.7c0 2-1.6 3.5-3.6 3.5h-19.8c-2 0-3.6-1.6-3.6-3.5v-43c0-10-5.9-16.7-14.5-16.7-10.7 0-17.6 7.3-17.6 23.7v36c0 2-1.6 3.5-3.6 3.5h-20c-2 0-3.5-1.6-3.5-3.5v-78c0-2 1.5-3.5 3.5-3.5h20c2 0 3.6 1.6 3.6 3.5v4.6a35 35 0 0126-10.7c19.9 0 33 14 33 35.4zM859 135.2c.5 1.6-.3 3.4-1.8 4.1-5.8 2.9-12.2 5-20.6 5-21.1 0-33.8-11.6-33.8-34V78.3h-12c-1.9 0-3.5-1.6-3.5-3.6V60.2c0-2 1.6-3.5 3.6-3.5h11.9V35c0-2 1.5-3.5 3.5-3.5h20c2 0 3.6 1.6 3.6 3.5v21.6h21.5c2 0 3.5 1.6 3.5 3.5v14.4c0 2-1.6 3.6-3.5 3.6h-21.5v29.5c0 8.8 4.2 12.3 11.3 12.3 2.6 0 6-.7 8.9-1.8 2-.7 4 .4 4.6 2.4l4.3 14.6zm-112.3 3v-78c0-2 1.6-3.5 3.6-3.5h20c2 0 3.5 1.6 3.5 3.5v78c0 2-1.6 3.5-3.5 3.5h-20c-2 0-3.6-1.6-3.6-3.5zM776 31.6c0 8.6-6.6 15-15.7 15-9.2 0-15.6-6.4-15.6-15 0-8.3 6.4-15.4 15.6-15.4 9.1 0 15.7 7.1 15.7 15.4zm-42.8 103.6c.5 1.6-.3 3.4-1.8 4.1-5.8 2.9-12.2 5-20.6 5-21.1 0-33.8-11.6-33.8-34V78.3h-12c-1.9 0-3.5-1.6-3.5-3.6V60.2c0-2 1.6-3.5 3.6-3.5H677V35c0-2 1.5-3.5 3.5-3.5h20c2 0 3.6 1.6 3.6 3.5v21.6h21.5c2 0 3.5 1.6 3.5 3.5v14.4c0 2-1.6 3.6-3.5 3.6H704v29.5c0 8.8 4.2 12.3 11.3 12.3 2.6 0 6-.7 8.9-1.8 2-.7 4 .4 4.6 2.4l4.3 14.6zm-85.9-43.5v46.5c0 2-1.5 3.5-3.5 3.5H638c-2 0-3.5-1.6-3.5-3.5V94c0-15.6-9.3-26-23.2-26-17.5 0-29 11.8-29 33.5v36.6c0 2-1.6 3.5-3.5 3.5H573c-2 0-3.6-1.6-3.6-3.5V61.7c0-2 1.6-3.5 3.6-3.5h5.8c2 0 3.5 1.6 3.5 3.5v10.4a35.9 35.9 0 0131.5-16c20.2 0 33.5 14.5 33.5 35.6zM479.1 93h58.1c-2.4-16.4-14-25.4-28-25.4A30 30 0 00479.2 93zm71.1 9.7h-71.6c1.2 18.8 15.4 30 29.8 30 11.1 0 21.2-4 27.3-15.5a3.6 3.6 0 014-1.9l4.6 1.1c2.2.6 3.3 3 2.3 5a40 40 0 01-38.2 22.6 42.2 42.2 0 01-42.3-43.7c0-26.8 20.1-44 43.2-44 22.5 0 40.1 16.7 41 41.6v4.8zM331 99.9a31.2 31.2 0 00-31.5-32.2c-17.2 0-31.8 13-31.8 32.2a31.5 31.5 0 0031.8 32.5A31.4 31.4 0 00331 99.9zm12.7 0a43.1 43.1 0 01-44.2 43.8 43 43 0 01-44.3-43.8 42.8 42.8 0 0144.3-43.6c24.6 0 44.2 18 44.2 43.6zM170.6 106.6v7.1h24.8c2 0 3.6 1.7 3.6 3.6v21.3c0 1.9-1.7 3.5-3.6 3.5h-24.8v28.5H142v24.8c0 2-1.6 3.6-3.5 3.6h-21.3a3.6 3.6 0 01-3.6-3.6v-24.8h-7v-24.9c0-1.9 1.6-3.6 3.5-3.6h32v-32c0-1.8 1.6-3.5 3.5-3.5h24.9zm-117.3 0c1.8 0 3.4 1.6 3.6 3.4v32.2h32c1.8 0 3.4 1.5 3.5 3.3V170.6h-7.1v24.8c0 2-1.7 3.6-3.6 3.6H60.4a3.6 3.6 0 01-3.5-3.6v-24.8H28.4V142H3.6a3.6 3.6 0 01-3.6-3.5v-21.3c0-2 1.7-3.6 3.6-3.6h24.8v-7h24.9zm74.6-35.5v56.8H71.1V71.1h56.8zM81.7 0c2 0 3.6 1.7 3.6 3.6v24.8h7v24.9c0 1.9-1.6 3.6-3.5 3.6h-32v32c0 1.8-1.6 3.5-3.5 3.5H28.4v-7.1H3.6A3.6 3.6 0 010 81.7V60.4C0 58.5 1.7 57 3.6 57h24.8V28.4H57V3.6c0-2 1.6-3.6 3.5-3.6h21.3zm56.9 0c1.9 0 3.5 1.7 3.5 3.6v24.8h28.5V57h24.8c2 0 3.6 1.6 3.6 3.5v21.3c0 2-1.7 3.6-3.6 3.6h-24.8v7h-24.9a3.7 3.7 0 01-3.6-3.3V56.8h-32a3.7 3.7 0 01-3.5-3.3V28.4h7.1V3.6c0-2 1.7-3.6 3.6-3.6h21.3z"/> - </g> - </svg> - <span class="sr-only">opentitan.org</span> - </a> - </h1> - - <nav id="main-nav" class="main-nav" aria-label="Main"> - <ul id="menu" class="main-nav__list"> - <li class="main-nav__item"> - <a href="https://opentitan.org">Home</a> - </li> - <li class="main-nav__item"> - <a href="https://docs.opentitan.org">Documentation</a> - </li> - <li class="main-nav__item user-toggle"> - <button class="[ toggle-button ] [ js-mode-toggle ]" aria-label="Switch light and dark theme"> - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> - <path fill="currentColor" d="M12 2a10 10 0 01.3 20H12a10 10 0 110-20zm0 2a8 8 0 100 16v-3a5 5 0 010-10V4zm0 4v8a4 4 0 100-8z" fill-rule="evenodd"/> - </svg> - </button> - </li> - </ul> - </nav> -</header>
diff --git a/site/docs/layouts/partials/menu.html b/site/docs/layouts/partials/menu.html deleted file mode 100644 index 1d36eb6..0000000 --- a/site/docs/layouts/partials/menu.html +++ /dev/null
@@ -1,44 +0,0 @@ -<div class="menu"> - <ul> - {{- $displayedNode := . }} - {{- template "menu-loop" dict "currentnode" .Site.Home "displayednode" $displayedNode }} - </ul> -</div> - -<!-- Template --> -{{- define "menu-loop" }} - {{- $currentNode := .currentnode }} - {{- $displayedNode := .displayednode }} - {{- with .currentnode}} - {{- $numberOfPages := (add (len .Pages) (len .Sections)) }} - <li> - <a class="{{- if .IsAncestor $displayedNode }} ancestor{{- end }} - {{- if eq .RelPermalink $displayedNode.RelPermalink}} active{{- end }} - {{- if .IsSection}} section{{- end }}" href="{{- .RelPermalink }}"> - {{- if .LinkTitle }} - {{- .LinkTitle }} - {{- else }} - {{- $noparent := .File.Dir }} - {{- if .Parent.File }} - {{- $noparent = replace .File.Dir .Parent.File.Dir "" }} - {{- end }} - {{- replaceRE "/" "-" $noparent }}{{- .File.TranslationBaseName }} - {{- end }} - </a> - {{- if (or (.IsDescendant $displayedNode) (.IsAncestor $displayedNode) (.InSection $displayedNode)) }} - <ul class="{{- if .IsAncestor $displayedNode}} ancestor{{- end }} - {{- if ne $numberOfPages 0 }} parent{{- end }}"> - {{- $subElements := dict }} - {{- range (where .Site.Pages ".Params.unlisted" "!=" "true") }} - {{- if and (eq .Parent $currentNode) (.IsDescendant $currentNode) }} - {{- $subElements = merge $subElements (dict (string .) . ) }} - {{- end }} - {{- end }} - {{- range $subElements }} - {{- template "menu-loop" dict "currentnode" . "displayednode" $displayedNode }} - {{- end }} - </ul> - {{- end }} - </li> - {{- end }} -{{- end }}
diff --git a/site/docs/layouts/partials/parents.html b/site/docs/layouts/partials/parents.html deleted file mode 100644 index 27e6957..0000000 --- a/site/docs/layouts/partials/parents.html +++ /dev/null
@@ -1,20 +0,0 @@ -<div class="parents"> - <ul> - {{- $currentNode := . }} - {{- template "parent-loop" dict "currentnode" $currentNode }} - -</ul> -</div> - -{{- define "parent-loop" }} -{{- $currentNode := .currentnode }} -{{- $currentParent := $currentNode.Parent }} - {{- if ne .Site.Home $currentParent}} - <li {{ if eq $currentParent.Parent .Site.Home }} style="list-style-type:none;" {{ end }}> - <a href="{{ $currentParent.RelPermalink }}">{{ $currentParent.Title }}</a> - </li> - {{- $currentNode = $currentParent }} - {{- template "parent-loop" dict "currentnode" $currentNode }} - {{ end }} -{{- end }} -
diff --git a/site/docs/layouts/partials/toc.html b/site/docs/layouts/partials/toc.html deleted file mode 100644 index f423e59..0000000 --- a/site/docs/layouts/partials/toc.html +++ /dev/null
@@ -1,8 +0,0 @@ -{{ if (gt .WordCount 400) }} -<aside class="toc"> - <header> - <p>On this Page</p> - </header> - {{ .TableOfContents }} -</aside> -{{ end }}
diff --git a/site/docs/layouts/shortcodes/dashboard.html b/site/docs/layouts/shortcodes/dashboard.html deleted file mode 100644 index a2477eb..0000000 --- a/site/docs/layouts/shortcodes/dashboard.html +++ /dev/null
@@ -1,14 +0,0 @@ -<table class="hw-project-dashboard"> - <thead> - <tr> - <th>Design Spec</th> - <th>DV Document</th> - <th><a href="{{ relref . "doc/project/development_stages#versioning" }}">Spec Version</a></th> - <th colspan="4"><a href="{{ relref . "doc/project/development_stages#life-stages" }}">Development Stage</a></th> - <th>Notes</th> - </tr> - </thead> - <tbody> -{{ readFile (path.Join .Site.Params.generatedRoot (.Get 0) "dashboard") | safeHTML }} - </tbody> -</table>
diff --git a/site/docs/layouts/shortcodes/dif_listing.html b/site/docs/layouts/shortcodes/dif_listing.html deleted file mode 100644 index 2dc6af1..0000000 --- a/site/docs/layouts/shortcodes/dif_listing.html +++ /dev/null
@@ -1,6 +0,0 @@ -{{ $baseName := .Get 0 }} -{{ $path := path.Join .Site.Params.generatedRoot (printf "sw/difs_listings/%s.html" $baseName) }} -{{ if not (fileExists $path) }} - {{ errorf "DIF listings have not been generated for %s" $baseName }} -{{ end }} -{{ readFile $path | safeHTML }}
diff --git a/site/docs/layouts/shortcodes/difref.html b/site/docs/layouts/shortcodes/difref.html deleted file mode 100644 index 589a89f..0000000 --- a/site/docs/layouts/shortcodes/difref.html +++ /dev/null
@@ -1,6 +0,0 @@ -{{ $difName := .Get 0 }} -{{ $path := path.Join .Site.Params.generatedRoot (printf "sw/difref/%s.html" $difName) }} -{{ if not (fileExists $path) }} - {{ errorf "DIF reference has not been generated for %s" $difName }} -{{ end }} -{{ readFile $path | safeHTML }}
diff --git a/site/docs/layouts/shortcodes/incGenFromIpDesc.html b/site/docs/layouts/shortcodes/incGenFromIpDesc.html deleted file mode 100644 index 9e6bbc1..0000000 --- a/site/docs/layouts/shortcodes/incGenFromIpDesc.html +++ /dev/null
@@ -1,43 +0,0 @@ -{{/* -A Hugo shortcode to include the content generated from the IP description Hjson - -Usage: {{< incGenFromIpDesc hjsonPath contentType >}} - -hjsonPath: Path to an IP description file in Hjson (ip_name.hjson) - Relative paths are resolved relative to the directory using the shortcode. - Absolute paths are resolved relative to REPO_TOP. - - This path could also be a testplan described in Hjson - (ip_name_testplan.hjson). Testplans may additionally be suffixed with "tags" - separated with ":" colon delimiter, such as "ip_name_testplan.hjson:foo:bar". - The tags are extracted from the path and appended at the end to construct the - path of the generated content, for example: - "ip_name_testplan.hjson.foo_bar_testplan" - -contentType: Type of generated content to include. - Valid options: testplan, hwcfg, registers - -The actual content is rendered as HTML by the util/build_docs.py script and only -included by the shortcode here. -*/}} - -{{ $hjsonPath := .Get 0 }} -{{ $contentType := .Get 1 }} -{{ $ipDescFile := (printf "%s.%s" $hjsonPath $contentType) }} - -{{ if eq $contentType "testplan" }} - {{ $splitTags := split $hjsonPath ":" }} - {{ $tags := (cond (gt (len $splitTags) 1) (delimit (after 1 $splitTags) "_") "") }} - {{ $ipDescFile = (printf "%s.%s_%s" (index $splitTags 0) $tags $contentType) }} -{{ end }} - -{{ $path := "UNDEF" }} -{{ if (hasPrefix $ipDescFile "/") }} - {{ $path = path.Join .Site.Params.generatedRoot $ipDescFile }} -{{ else }} - {{ $path = path.Join .Site.Params.generatedRoot .Page.File.Dir $ipDescFile }} -{{ end }} -{{ if not (fileExists $path) }} - {{ errorf "HTML for %s has not been generated for %s (looked at %s)" $contentType $hjsonPath $path }} -{{ end }} -{{ readFile $path | safeHTML }}
diff --git a/site/docs/layouts/shortcodes/otbnInsnRef.html b/site/docs/layouts/shortcodes/otbnInsnRef.html deleted file mode 100644 index f05b8b9..0000000 --- a/site/docs/layouts/shortcodes/otbnInsnRef.html +++ /dev/null
@@ -1,10 +0,0 @@ -{{/* - A Hugo shortcode to link to an OTBN instruction. - - Usage: {{< otbnInsnRef insn >}} - - insn: Name of the instruction to link to (e.g. BN.WSRR). - */}} -{{ $insn := .Get 0 }} -{{ $ref := lower (replace $insn "." "") }} -<a href='{{ ref . (printf "/hw/ip/otbn/doc/isa#%s" $ref) }}'>{{ $insn }}</a>
diff --git a/site/docs/layouts/shortcodes/otbn_isa.html b/site/docs/layouts/shortcodes/otbn_isa.html deleted file mode 100644 index 06fbb7d..0000000 --- a/site/docs/layouts/shortcodes/otbn_isa.html +++ /dev/null
@@ -1,7 +0,0 @@ -{{ $group := .Get 0 }} -{{ $basename := (print $group ".md") }} -{{ $path := path.Join .Site.Params.generatedRoot "otbn-isa" $basename }} -{{ if not (fileExists $path) }} - {{ errorf "%s has not been generated" $path }} -{{ end }} -{{ readFile $path | markdownify }}
diff --git a/site/docs/layouts/shortcodes/pkgmgr_cmd.html b/site/docs/layouts/shortcodes/pkgmgr_cmd.html deleted file mode 100644 index 94a1355..0000000 --- a/site/docs/layouts/shortcodes/pkgmgr_cmd.html +++ /dev/null
@@ -1,8 +0,0 @@ -{{- $pkgmgr := .Get 0 -}} -{{- $file := (print $pkgmgr "_cmd.txt") -}} -{{- $path := path.Join .Site.Params.generatedRoot $file -}} -{{- if not (fileExists $path) -}} - {{- errorf (print $file " has not been generated") -}} -{{- end -}} - -<pre><code class="language-console" data-lang="console">{{ readFile $path | safeHTML }}</code></pre>
diff --git a/site/docs/layouts/shortcodes/regref.html b/site/docs/layouts/shortcodes/regref.html deleted file mode 100644 index fad8d65..0000000 --- a/site/docs/layouts/shortcodes/regref.html +++ /dev/null
@@ -1,3 +0,0 @@ -{{ $base_url := "" }} -{{ if len .Params | eq 2 }}{{ $base_url = relref . (.Get 1) }}{{ end }} -{{ $name := .Get 0 }}{{ $ref := lower (index (split $name ".") 0) }}<a href="{{ $base_url }}#Reg_{{ $ref }}">{{ $name }}</a>{{- "" -}}
diff --git a/site/docs/layouts/shortcodes/render.html b/site/docs/layouts/shortcodes/render.html deleted file mode 100644 index 857ace6..0000000 --- a/site/docs/layouts/shortcodes/render.html +++ /dev/null
@@ -1,23 +0,0 @@ -{{ $url := .Get 0 }} -{{ $id := printf "__render_%v" .Ordinal }} -<div id="{{ $id }}"> - Loading {{ $url }}... -</div> -<script type="text/javascript"> - (function() { - function renderContent(event) { - var md = window.markdownit(); - var rendered = md.render(event.target.responseText); - document.getElementById('{{ $id }}').innerHTML = rendered; - } - - function loadContent(event) { - var request = new XMLHttpRequest(); - request.addEventListener('load', renderContent); - request.open('GET', '{{ $url }}'); - request.send(); - } - - window.addEventListener('load', loadContent); - })(); -</script>
diff --git a/site/docs/layouts/shortcodes/sectionContent.html b/site/docs/layouts/shortcodes/sectionContent.html deleted file mode 100644 index bad3cb6..0000000 --- a/site/docs/layouts/shortcodes/sectionContent.html +++ /dev/null
@@ -1,50 +0,0 @@ -<div class="sectioncontent"> - {{- $contentType := "all"}} - {{- if eq (.Get "type") "section" }} - {{- $contentType = "section" }} - {{- end}} - {{- $depthLimit := 2 }} - {{- with .Get "depth" }} - {{- $depthLimit = . }} - {{- end }} - - {{- $startSection := .Page.Page }} - {{- template "sectioncontent-loop" dict "startSection" $startSection "currentSection" $startSection "contentType" $contentType "depthLimit" $depthLimit "depthCnt" 0 }} -</div> - -{{- define "sectioncontent-loop" }} - {{- $startSection := .startSection }} - {{- $currentSection := .currentSection }} - {{- $contentType := .contentType }} - {{- $depthLimit := .depthLimit }} - {{- $depthCnt := add .depthCnt 1 }} - {{- with .startSection }} - <li> - {{- with $currentSection }} - {{- if and (ne $startSection $currentSection) (or (ne $contentType "section") .IsSection) }} - {{- if .LinkTitle }} - <a href="{{.RelPermalink}}">{{- .LinkTitle }}</a> - {{- else }} - {{- replace .File.Dir .Parent.File.Dir "" | replaceRE "/" "-" | replaceRE "-$" ":" }} - <a href="{{.RelPermalink}}">{{- .File.TranslationBaseName }}</a> - {{- end }} - {{- end }} - {{- end }} - {{- if le $depthCnt $depthLimit }} - <ul> - {{- $elem := dict }} - {{- range .Site.Pages }} - {{- if and (eq .CurrentSection $currentSection.CurrentSection) (ne $currentSection .) (ne $startSection .) (.IsDescendant $currentSection) }} - {{- $elem = merge $elem (dict (string .) .) }} - {{- else if and (eq $currentSection .Parent) (.IsSection) (ne .CurrentSection $currentSection.CurrentSection) (ne $startSection .) (.IsDescendant $currentSection) }} - {{- $elem = merge $elem (dict (string .) .) }} - {{- end }} - {{- end }} - {{- range $elem }} - {{- template "sectioncontent-loop" dict "startSection" $startSection "currentSection" . "contentType" $contentType "depthLimit" $depthLimit "depthCnt" $depthCnt }} - {{- end }} - </ul> - {{- end }} - </li> - {{- end }} -{{- end }}
diff --git a/site/docs/layouts/shortcodes/selfdoc.html b/site/docs/layouts/shortcodes/selfdoc.html deleted file mode 100644 index 05288cf..0000000 --- a/site/docs/layouts/shortcodes/selfdoc.html +++ /dev/null
@@ -1,6 +0,0 @@ -{{ $baseName := .Get 0 }} -{{ $path := path.Join .Site.Params.generatedRoot (printf "%s.selfdoc" $baseName) }} -{{ if not (fileExists $path) }} - {{ errorf "Tool selfdoc has not been generated for %s" $baseName }} -{{ end }} -{{ readFile $path | safeHTML }}
diff --git a/site/docs/layouts/shortcodes/snippet.html b/site/docs/layouts/shortcodes/snippet.html deleted file mode 100644 index 8ea1849..0000000 --- a/site/docs/layouts/shortcodes/snippet.html +++ /dev/null
@@ -1 +0,0 @@ -{{ readFile (path.Join .Page.File.Dir (.Get 0)) | markdownify }}
diff --git a/site/docs/layouts/shortcodes/tool_version.html b/site/docs/layouts/shortcodes/tool_version.html deleted file mode 100644 index a32741f..0000000 --- a/site/docs/layouts/shortcodes/tool_version.html +++ /dev/null
@@ -1,7 +0,0 @@ -{{- $tool := .Get 0 -}} -{{- $file := (print "version_" $tool ".txt") -}} -{{- $path := path.Join .Site.Params.generatedRoot $file -}} -{{- if not (fileExists $path) -}} - {{- errorf (print $file " has not been generated") -}} -{{- end -}} -{{- readFile $path | plainify -}}
diff --git a/site/docs/layouts/shortcodes/topLevelDoc.html b/site/docs/layouts/shortcodes/topLevelDoc.html deleted file mode 100644 index 1f7b64e..0000000 --- a/site/docs/layouts/shortcodes/topLevelDoc.html +++ /dev/null
@@ -1,23 +0,0 @@ -{{/* -A Hugo shortcode to include the content generated from the top level description Hjson - -Usage: {{< topLevelDoc topLevel contentType >}} - -topLevel: Top level name (e.g. earlgrey) - -contentType: Type of generated content to include. - Valid options: mmap, pinout - -The actual content is rendered as Markdown by the util/build_docs.py script and only -included by the shortcode here. - -Also see util/design/gen-top-docs.py for more details. -*/}} -{{ $top := .Get 0 }} -{{ $type := .Get 1 }} -{{ $basename := (print $type ".md") }} -{{ $path := path.Join .Site.Params.generatedRoot "top" $top $basename }} -{{ if not (fileExists $path) }} - {{ errorf "%s has not been generated" $path }} -{{ end }} -{{ readFile $path | markdownify }}
diff --git a/site/docs/layouts/shortcodes/wavejson.html b/site/docs/layouts/shortcodes/wavejson.html deleted file mode 100644 index ca1a522..0000000 --- a/site/docs/layouts/shortcodes/wavejson.html +++ /dev/null
@@ -1,3 +0,0 @@ -<script type="WaveDrom"> - {{ $.Inner }} -</script>