aboutsummaryrefslogtreecommitdiff
path: root/layout.html
diff options
context:
space:
mode:
authorJakob Odersky <jakob@driver.xyz>2018-09-14 17:59:21 -0700
committerJakob Odersky <jakob@driver.xyz>2018-09-14 17:59:21 -0700
commit876fccbbde53e27b3fb820808d2c336ca71aa7e1 (patch)
tree0143fa9b434091470d2466a6d719e9bb37d969d9 /layout.html
parent07fb4ce6471aef531a1246c8fd9d200f23c119d2 (diff)
downloadbest-practices-876fccbbde53e27b3fb820808d2c336ca71aa7e1.tar.gz
best-practices-876fccbbde53e27b3fb820808d2c336ca71aa7e1.tar.bz2
best-practices-876fccbbde53e27b3fb820808d2c336ca71aa7e1.zip
Make this repo a standalone website
These changes add the ability to generate a full website from individual style guides. The website can be viewed [here](drivergroup.github.io/best-practices). Also included, are the following additions: - Improve recommendations for Scala. - Add more recommendations for Git. - Add recommendations for Shell Script.
Diffstat (limited to 'layout.html')
-rw-r--r--layout.html112
1 files changed, 112 insertions, 0 deletions
diff --git a/layout.html b/layout.html
new file mode 100644
index 0000000..410a2fc
--- /dev/null
+++ b/layout.html
@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="$lang$" xml:lang="$lang$"$if(dir)$ dir="$dir$"$endif$>
+ <head>
+ <meta charset="utf-8" />
+ <meta name="generator" content="pandoc" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+ $for(author-meta)$
+ <meta name="author" content="$author-meta$" />
+ $endfor$
+ $if(date-meta)$
+ <meta name="dcterms.date" content="$date-meta$" />
+ $endif$
+ $if(keywords)$
+ <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" />
+ $endif$
+ <title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$</title>
+ <style type="text/css">
+ code{white-space: pre-wrap;}
+ span.smallcaps{font-variant: small-caps;}
+ span.underline{text-decoration: underline;}
+ div.column{display: inline-block; vertical-align: top; width: 50%;}
+ $if(quotes)$
+ q { quotes: "“" "”" "‘" "’"; }
+ $endif$
+ </style>
+ $if(highlighting-css)$
+ <style type="text/css">
+ $highlighting-css$
+ </style>
+ $endif$
+ <link rel="stylesheet" href="assets/lib/bootstrap/bootstrap.min.css">
+ <link rel="stylesheet" href="assets/lib/fontawesome/css/font-awesome.min.css">
+ <link rel="stylesheet" href="assets/stylesheets/main.css">
+ $for(css)$
+ <link rel="stylesheet" href="$css$" />
+ $endfor$
+ $if(math)$
+ $math$
+ $endif$
+ $for(header-includes)$
+ $header-includes$
+ $endfor$
+ </head>
+ <body>
+ $for(include-before)$
+ $include-before$
+ $endfor$
+ $if(title)$
+ <header class="container">
+ <div style="text-align: center;">
+ <h1>$title$</h1>
+ $if(subtitle)$
+ <p class="subtitle">$subtitle$</p>
+ $endif$
+ <nav class="my-4">
+ <a class="btn btn-light" href="css.html">
+ <img src="assets/images/css.svg" width="16px" class="img-fluid">
+ CSS
+ </a>
+ <a class="btn btn-light" href="git.html">
+ <img src="assets/images/git.png" width="16px" class="img-fluid">
+ Git
+ </a>
+ <a class="btn btn-light" href="html.html">
+ <img src="assets/images/html5.svg" width="16px" class="img-fluid">
+ HTML
+ </a>
+ <a class="btn btn-light" href="javascript.html">
+ <img src="assets/images/javascript.png" width="16px" class="img-fluid">
+ JavaScript
+ </a>
+ <a class="btn btn-light" href="scala.html">
+ <img src="assets/images/scala.png" width="16px" class="img-fluid">
+ Scala
+ </a>
+ <a class="btn btn-light" href="shell-script.html">
+ <img src="assets/images/bash.svg" width="16px" class="img-fluid">
+ Shell Script
+ </a>
+ </nav>
+ </div>
+ $if(toc)$
+ <nav id="$idprefix$TOC">
+ $table-of-contents$
+ </nav>
+ $endif$
+ </header>
+ $endif$
+ <div class="container">
+ This guide recommends stylistic and architectural best
+ practices, designed to make your code easier for others to
+ understand. It offers <em>guidelines</em> not <em>rules</em>,
+ and there are situations in which the advice offered
+ should be actively ignored.
+ <hr>
+ </div>
+ <main class="container">
+ $body$
+ </main>
+ <footer class="small mt-6 mb-1">
+ $if(date)$
+ <span class="date">$date$</span>
+ $endif$
+ $if(url)$
+ | <a href="$url$/$sourcefile$" style="display: inline-block;"><i class="fa fa-github"></i> Edit on GitHub</a>
+ $endif$
+ </footer>
+ $for(include-after)$
+ $include-after$
+ $endfor$
+ </body>
+</html>