very early checkin of template for user-docs, only a few pages filled out

4 files changed, 632 insertions, 0 deletions

diff --git a/mkdocs-material/src/assets/stylesheets/modules/base/_animation.scss b/mkdocs-material/src/assets/stylesheets/modules/base/_animation.scss
new file mode 100644
index 00000000..720621f6
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/base/_animation.scss
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Base animation
+ * ------------------------------------------------------------------------- */
+
+/*
+ * Animate color on hover
+ */
+a {
+  transition: color .25s;
+}
+
+/*
+ * Overlay
+ */
+.overlay {
+  transition: opacity .25s,
+              width   .0s .25s,
+              height  .0s .25s;
+
+  /*
+   * Expanded drawer
+   */
+  #toggle-drawer:checked ~ &,
+  .toggle-drawer & {
+    transition: opacity .25s,
+                width   .0s,
+                height  .0s;
+  }
+}
+
+/*
+ * Application header - check for javascript to omit flashing
+ */
+.js .header {
+  transition: background .6s,
+              color      .6s;
+
+  /*
+   * Status bar
+   */
+  &:before {
+    transition: background .6s;
+  }
+}
+
+/*
+ * Extended visible touch area on icon
+ */
+.button .icon {
+  transition: background .25s;
+}
\ No newline at end of file
diff --git a/mkdocs-material/src/assets/stylesheets/modules/base/_appearance.scss b/mkdocs-material/src/assets/stylesheets/modules/base/_appearance.scss
new file mode 100644
index 00000000..5f0870c1
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/base/_appearance.scss
@@ -0,0 +1,138 @@
+/*
+ * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Base appearance
+ * ------------------------------------------------------------------------- */
+
+/*
+ * Device specific background hacks related to rubberband
+ */
+body {
+  color: $black;
+
+  /* Hack [Chrome, Opera]: Set background color in Chrome and Opera */
+  @supports (-webkit-appearance: none) {
+    background: $primary;
+  }
+
+  /*
+   * Don't tint menu bar on iOS
+   */
+  .ios & {
+    background: $white;
+  }
+}
+
+/*
+ * Horizontal separators
+ */
+hr {
+  border: 0;
+  border-top: 1px solid $black-lightest;
+}
+
+/*
+ * Toggle button
+ */
+.toggle-button {
+  cursor: pointer;
+  color: inherit;
+}
+
+/*
+ * Backdrop
+ */
+.backdrop {
+  background: $white;
+
+  /* [tablet landscape+]: Introduce paper with shadow */
+  @include break-from-device(tablet landscape) {
+    background: darken($white, 5%);
+  }
+}
+
+/*
+ * Backdrop paper with shadow
+ */
+.backdrop-paper:after {
+  background: $white;
+
+  /* [tablet landscape+]: Add drop shadow */
+  @include break-from-device(tablet landscape) {
+    @include drop-shadow(1);
+  }
+}
+
+/*
+ * Overlay
+ */
+.overlay {
+  background: $black-light;
+  opacity: 0;
+
+  /*
+   * Expanded drawer
+   */
+  #toggle-drawer:checked ~ &,
+  .toggle-drawer & {
+    opacity: 1;
+  }
+}
+
+/*
+ * Application header
+ */
+.header {
+  @include drop-shadow(1);
+
+  background: $primary;
+  color: $white;
+
+  /*
+   * Add status bar overlay for iOS web application
+   */
+  .ios.standalone &:before {
+    background: $black-lightest;
+  }
+}
+
+/*
+ * Navigation path within header bar
+ */
+.bar .path {
+  color: $white-light;
+}
+
+/*
+ * Draw round area around icon on touch
+ */
+.button .icon {
+  border-radius: 100%;
+}
+
+/*
+ * Pushed/clicked icon
+ */
+.button .icon:active {
+  background: $white-lightest;
+}
\ No newline at end of file
diff --git a/mkdocs-material/src/assets/stylesheets/modules/base/_layout.scss b/mkdocs-material/src/assets/stylesheets/modules/base/_layout.scss
new file mode 100644
index 00000000..2a456915
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/base/_layout.scss
@@ -0,0 +1,363 @@
+/*
+ * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Base layout
+ * ------------------------------------------------------------------------- */
+
+/*
+ * Stretch container to viewport
+ */
+html {
+  height: 100%;
+}
+
+/*
+ * Stretch body to container and leave room for sticky footer.
+ */
+body {
+  position: relative;
+  min-height: 100%;
+}
+
+/*
+ * Horizontal separators
+ */
+hr {
+  display: block;
+  height: 1px;
+  padding: 0;
+  margin: 0;
+}
+
+/*
+ * Lock body (e.g. in search mode)
+ */
+.locked {
+  height: 100%;
+  overflow: hidden;
+}
+
+/*
+ * Scrollable container
+ */
+.scrollable {
+  @include position(absolute, 0 0 0 0);
+
+  overflow: auto;
+  -webkit-overflow-scrolling: touch;
+
+  /*
+   * Content wrapper
+   */
+  .wrapper {
+    height: 100%;
+
+    /* Hack [iOS]: Force overflow scrolling */
+    .ios & {
+      margin-bottom: 2px;
+    }
+  }
+}
+
+/*
+ * Toggle states and button
+ */
+.toggle {
+  display: none;
+
+  /*
+   * Toggle button
+   */
+  &-button {
+    display: block;
+  }
+}
+
+/*
+ * Backdrop
+ */
+.backdrop {
+  @include position(absolute, 0 0 0 0);
+
+  z-index: -1;
+}
+
+/*
+ * Backdrop paper container
+ */
+.backdrop-paper {
+  max-width: 1200px;
+  height: 100%;
+  margin-left: auto;
+  margin-right: auto;
+
+  /*
+   * Actual paper
+   */
+  &:after {
+    content: " ";
+    display: block;
+    height: 100%;
+    margin-left: 262px;
+  }
+}
+
+/*
+ * Overlay
+ */
+.overlay {
+  position: fixed;
+  top: 0;
+  width: 0;
+  height: 0;
+  z-index: 4;
+
+  /* [tablet landscape-]: Trigger overlay */
+  @include break-to-device(tablet landscape) {
+
+    /*
+     * Expanded drawer
+     */
+    #toggle-drawer:checked ~ &,
+    .toggle-drawer & {
+      width: 100%;
+      height: 100%;
+    }
+  }
+}
+
+/*
+ * Application header stays always on top
+ */
+.header {
+  @include user-select(none);
+
+  position: fixed;
+  top: 0;
+  left: 0;
+  z-index: 3;
+  height: 56px;
+  padding: 4px;
+  overflow: hidden;
+
+  /* [tablet portait+]: Larger header bar */
+  @include break-from-device(tablet portrait) {
+    height: 64px;
+    padding: 8px;
+  }
+
+  /* [screen+]: Stretch to screen */
+  @include break-from-device(screen) {
+    width: 100%;
+  }
+
+  /*
+   * Absolute positioning in iOS web application
+   */
+  .ios.standalone & {
+    position: absolute;
+
+    /* [orientation: portrait]: Account for status bar in portrait mode */
+    @include break-at-orientation(portrait) {
+      height: (56px + 20px);
+      padding-top: (4px + 20px);
+
+      /* [tablet portait+]: Larger header bar */
+      @include break-from-device(tablet portrait) {
+        height: (64px + 20px);
+        padding-top: (8px + 20px);
+      }
+
+      /*
+       * Add status bar overlay
+       */
+      &:before {
+        content: " ";
+        position: absolute;
+        top: 0;
+        left: 0;
+        z-index: 4;
+        width: 100%;
+        height: 20px;
+      }
+    }
+  }
+}
+
+/*
+ * Header bar
+ */
+.bar {
+  display: table;
+  max-width: 1184px;
+  margin-left: auto;
+  margin-right: auto;
+
+  /*
+   * Links should span icons entirely
+   */
+  a {
+    display: block;
+  }
+
+  /*
+   * Hide search button, in case javascript is not available.
+   */
+  .no-js & .button-search {
+    display: none;
+  }
+
+  /*
+   * Navigation path
+   */
+  .path {
+
+    /*
+     * Correct icon alignment
+     */
+    .icon:before {
+      vertical-align: -1.5px;
+    }
+
+    /* [tablet portait-]: Hide path */
+    @include break-to-device(tablet portrait) {
+      display: none;
+    }
+  }
+}
+
+/*
+ * Buttons
+ */
+.button {
+  display: table-cell;
+  vertical-align: top;
+  width: 1%;
+
+  /*
+   * Remove native spacing on button
+   */
+  button {
+    margin: 0;
+    padding: 0;
+
+    /* Hack [IE]: Remove button offset in active state */
+    &:active:before {
+      position: relative;
+      top: 0;
+      left: 0;
+    }
+  }
+
+  /*
+   * Button icons
+   */
+  .icon {
+    display: inline-block;
+    font-size: 24px;
+    padding: 8px;
+    margin: 4px;
+  }
+}
+
+/*
+ * Hide source and twitter button
+ */
+.button-github,
+.button-twitter {
+
+  /* [mobile landscape-]: Hide button */
+  @include break-to-device(mobile landscape) {
+    display: none;
+  }
+}
+
+/*
+ * Hide menu button
+ */
+.button-menu {
+
+  /* [tablet landscape+]: Hide button */
+  @include break-from-device(tablet landscape) {
+    display: none;
+  }
+}
+
+/*
+ * Stretch content to remaining space
+ */
+.stretch {
+  display: table;
+  table-layout: fixed;
+  width: 100%;
+
+  /*
+   * Set vertical spacing for header
+   */
+  .header & {
+    padding: 0 20px;
+
+    /* [tablet portait]: Increase vertical spacing */
+    @include break-at-device(tablet portrait) {
+      padding: 0 24px;
+    }
+
+    /* [tablet portait+]: Account for missing menu icon */
+    @include break-from-device(tablet portrait) {
+      padding: 0 (24px - 8px) 0 16px;
+    }
+  }
+
+  /*
+   * Title with ellipsis on overflow
+   */
+  .title {
+    display: table-cell;
+    overflow: hidden;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+
+    /*
+     * Increase header font size
+     */
+    .header & {
+      font-size: 18px;
+      padding: 13px 0;
+
+      /* [tablet portait+]: Slightly larger typography in header */
+      @include break-from-device(tablet portrait) {
+        font-size: 20px;
+        padding: 12px 0;
+      }
+    }
+  }
+}
+
+/*
+ * Main content
+ */
+.main {
+  max-width: 1200px;
+  margin-left: auto;
+  margin-right: auto;
+}
\ No newline at end of file
diff --git a/mkdocs-material/src/assets/stylesheets/modules/base/_typography.scss b/mkdocs-material/src/assets/stylesheets/modules/base/_typography.scss
new file mode 100644
index 00000000..037e46a5
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/base/_typography.scss
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Base typography
+ * ------------------------------------------------------------------------- */
+
+/*
+ * Default font styles
+ */
+body, input {
+  font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
+  font-weight: 400;
+
+  /* Enable font-smoothing in Webkit and FF */
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+
+  /*
+   * Use system fonts, if browser doesn't support webfonts
+   */
+  .no-fontface & {
+    font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
+  }
+}
+
+/*
+ * Proportional fonts
+ */
+pre, code, kbd {
+  font-family: 'Courier New', 'Courier', monospace;
+
+  /*
+   * Use system fonts, if browser doesn't support webfonts
+   */
+  .no-fontface & {
+    font-family: 'Courier New', 'Courier', monospace;
+  }
+}
\ No newline at end of file