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

4 files changed, 520 insertions, 0 deletions

diff --git a/mkdocs-material/src/assets/stylesheets/modules/search/_animation.scss b/mkdocs-material/src/assets/stylesheets/modules/search/_animation.scss
new file mode 100644
index 00000000..37df48f3
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/search/_animation.scss
@@ -0,0 +1,134 @@
+/*
+ * 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.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Search animation
+ * ------------------------------------------------------------------------- */
+
+/*
+ * Animate header bar in offset and opacity
+ */
+.bar {
+  transform: translate3d(0, 0, 0);
+  transition: opacity   .2s cubic-bezier(.75, 0, .25, 1),
+              transform .4s cubic-bezier(.75, 0, .25, 1);
+
+  /*
+   * Active search mode
+   */
+  #toggle-search:checked ~ .header &,
+  .toggle-search & {
+    transform: translate3d(0, -56px, 0);
+  }
+
+  /*
+   * Search animations
+   */
+  &.search {
+
+    /*
+     * Hide reset button by default
+     */
+    .button-reset {
+      transform: scale(0.5, 0.5);
+      transition: opacity   .4s cubic-bezier(.1, .7, .1, 1),
+                  transform .4s cubic-bezier(.1, .7, .1, 1);
+      opacity: 0;
+    }
+
+    /*
+     * Show reset button if search is not empty
+     */
+    &.non-empty .button-reset {
+      transform: scale(1.0, 1.0);
+      opacity: 1;
+    }
+  }
+}
+
+/*
+ * Search results
+ */
+.results {
+  transition: opacity .3s .1s,
+              width   .0s .4s,
+              height  .0s .4s;
+
+  /*
+   * Active search mode
+   */
+  #toggle-search:checked ~ .main &,
+  .toggle-search & {
+    transition: opacity .4s,
+                width   .0s,
+                height  .0s;
+  }
+
+  /*
+   * Search result item link
+   */
+  .list a {
+    transition: background .25s;
+  }
+}
+
+/*
+ * Just hide and show bars, if browser doesn't support 3D transforms
+ */
+.no-csstransforms3d {
+
+  /*
+   * Show default bar
+   */
+  .bar.default {
+    display: table;
+  }
+
+  /*
+   * Hide search bar
+   */
+  .bar.search {
+    display: none;
+    margin-top: 0;
+  }
+
+  /*
+   * Active search mode
+   */
+  #toggle-search:checked ~ .header,
+  .toggle-search {
+
+    /*
+     * Hide default bar
+     */
+    .bar.default {
+      display: none;
+    }
+
+    /*
+     * Show search bar
+     */
+    .bar.search {
+      display: table;
+    }
+  }
+}
\ No newline at end of file
diff --git a/mkdocs-material/src/assets/stylesheets/modules/search/_appearance.scss b/mkdocs-material/src/assets/stylesheets/modules/search/_appearance.scss
new file mode 100644
index 00000000..045cd761
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/search/_appearance.scss
@@ -0,0 +1,139 @@
+/*
+ * 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.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Search appearance
+ * ------------------------------------------------------------------------- */
+
+/*
+ * Search bar
+ */
+.bar.search {
+  opacity: 0;
+
+  /*
+   * Search input
+   */
+  .query {
+    background: transparent;
+    color: $black;
+
+    /*
+     * Search input placeholder
+     */
+    @include placeholder {
+      color: $black-lighter;
+    }
+  }
+
+  /*
+   * Pushed/clicked icon
+   */
+  .button .icon:active {
+    background: $black-lightest;
+  }
+}
+
+/*
+ * Search results
+ */
+.results {
+  @include drop-shadow(2);
+
+  background: $white;
+  color: $black;
+  opacity: 0;
+
+  /*
+   * Active search mode
+   */
+  #toggle-search:checked ~ .main &,
+  .toggle-search & {
+    opacity: 1;
+  }
+
+  /*
+   * Search meta data
+   */
+  .meta {
+    background: $primary;
+    color: $white;
+  }
+
+  /*
+   * Search result item link
+   */
+  .list a {
+    border-bottom: 1px solid $black-lightest;
+
+    /*
+     * Remove border on last element
+     */
+    &:last-child {
+      border-bottom: none;
+    }
+
+    /*
+     * Active item link
+     */
+    &:active {
+      background: $black-lightest;
+    }
+  }
+}
+
+/*
+ * Article link
+ */
+.result span {
+  color: $black-light;
+}
+
+/*
+ * Active search bar
+ */
+#toggle-search:checked ~ .header,
+.toggle-search .header {
+  background: $white;
+  color: $black-light;
+
+  /*
+   * Add darker status bar overlay in search mode
+   */
+  &:before {
+    background: $black-light;
+  }
+
+  /*
+   * Fade out default header bar
+   */
+  .bar.default {
+    opacity: 0;
+  }
+
+  /*
+   * Fade in search header bar
+   */
+  .bar.search {
+    opacity: 1;
+  }
+}
\ No newline at end of file
diff --git a/mkdocs-material/src/assets/stylesheets/modules/search/_layout.scss b/mkdocs-material/src/assets/stylesheets/modules/search/_layout.scss
new file mode 100644
index 00000000..33c89be9
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/search/_layout.scss
@@ -0,0 +1,218 @@
+/*
+ * 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.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Search layout
+ * ------------------------------------------------------------------------- */
+
+/*
+ * Search bar
+ */
+.bar.search {
+  margin-top: 8px;
+
+  /*
+   * Search input
+   */
+  .query {
+    font-size: 18px;
+    padding: 13px 0;
+    margin: 0;
+    width: 100%;
+    height: 48px;
+
+    /* [tablet portait+]: Slightly larger typo */
+    @include break-from-device(tablet portrait) {
+      font-size: 20px;
+      padding: 12px 0;
+    }
+
+    /* Hack [IE]: Hide redundant clear button */
+    &::-ms-clear {
+      display: none;
+    }
+  }
+}
+
+/*
+ * Search results
+ */
+.results {
+  position: fixed;
+  top: 0;
+  left: 0;
+  width: 0;
+  height: 100%;
+  z-index: 2;
+  overflow-y: scroll;
+  -webkit-overflow-scrolling: touch;
+
+  /* [tablet landscape+]: Limit results to five entries */
+  @include break-from-device(tablet landscape) {
+    height: auto;
+    top: 64px;
+  }
+
+  /*
+   * Scrollable container
+   */
+  .scrollable {
+    top: 56px;
+
+    /* [tablet portait+]: Increase vertical spacing */
+    @include break-from-device(tablet portrait) {
+      top: 64px;
+    }
+
+    /* [tablet landscape+]: Limit results to five entries */
+    @include break-from-device(tablet landscape) {
+      position: static;
+      max-height: 413px;
+    }
+
+    /*
+     * Leave room for status bar in iOS web application
+     */
+    .ios.standalone & {
+
+      /* [orientation: portrait]: Account for status bar in portrait mode */
+      @include break-at-orientation(portrait) {
+        top: (56px + 20px);
+
+        /* [tablet portait+]: Increase vertical spacing */
+        @include break-from-device(tablet portrait) {
+          top: (64px + 20px);
+        }
+      }
+    }
+  }
+
+  /*
+   * Active search mode
+   */
+  #toggle-search:checked ~ .main &,
+  .toggle-search & {
+    width: 100%;
+
+    /* Hack [Firefox]: div doesn't collapse, unless this is applied */
+    overflow-y: visible;
+
+    /* [tablet portait+]: Stretch to viewport */
+    @include break-to-device(tablet landscape) {
+      height: 100%;
+    }
+  }
+
+  /*
+   * Search meta data
+   */
+  .meta {
+    font-weight: 700;
+
+    /*
+     * Number of results
+     */
+    strong {
+      display: block;
+      font-size: 11px;
+      max-width: 1200px;
+      margin-left: auto;
+      margin-right: auto;
+      padding: 16px;
+
+      /* [tablet portait+]: Increase vertical spacing */
+      @include break-from-device(tablet portrait) {
+        padding: 16px 24px;
+      }
+    }
+  }
+
+  /*
+   * Search result item link
+   */
+  .list a {
+    display: block;
+  }
+}
+
+/*
+ * Search result item
+ */
+.result {
+  max-width: 1200px;
+  margin-left: auto;
+  margin-right: auto;
+  padding: 12px 16px 16px;
+
+  /* [tablet portait+]: Increase vertical spacing */
+  @include break-from-device(tablet portrait) {
+    padding: 16px 24px 20px;
+  }
+
+  /*
+   * Article title
+   */
+  h1 {
+    line-height: 24px;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+    overflow: hidden;
+  }
+
+  /*
+   * Article link
+   */
+  span {
+    font-size: 12px;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+    overflow: hidden;
+  }
+}
+
+/*
+ * Switch visibility, if browser doesn't support 3D transforms
+ */
+.no-csstransforms3d {
+
+  /*
+   * Hide search results
+   */
+  .results {
+    display: none;
+  }
+
+  /*
+   * Active search mode
+   */
+  #toggle-search:checked ~ .main,
+  .toggle-search {
+
+    /*
+     * Show search results
+     */
+    .results {
+      display: block;
+      overflow: auto;
+    }
+  }
+}
\ No newline at end of file
diff --git a/mkdocs-material/src/assets/stylesheets/modules/search/_typography.scss b/mkdocs-material/src/assets/stylesheets/modules/search/_typography.scss
new file mode 100644
index 00000000..465f20ed
--- /dev/null
+++ b/mkdocs-material/src/assets/stylesheets/modules/search/_typography.scss
@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+
+/*
+ * Search meta data
+ */
+.meta {
+  text-transform: uppercase;
+  font-weight: 700;
+}
\ No newline at end of file