diff --git a/CHANGELOG.md b/CHANGELOG.md old mode 100644 new mode 100755 index d0c0768..be3c988 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog: +- - - +## 0.4.0 - 2018-10-11 + +#### Changed: +* [Refactored sliding (mobile) menu panel](https://github.com/hfagerlund/mkdocs-docskimmer/issues/11) +* Updated [demo](https://hfagerlund.github.io/mkdocs-docskimmer/) (to docSkimmer v0.4.0) +* Bumped version number - - - ## 0.3.1 - 2018-07-04 @@ -47,7 +54,7 @@ ## 0.1.1 - 2017-06-15 #### New features: -* Launched documentation site +* Launched [documentation site/demo](https://hfagerlund.github.io/mkdocs-docskimmer/) #### Changed: * Replaced screenshot diff --git a/README.md b/README.md old mode 100644 new mode 100755 index ccd6b5a..6ab5e3c --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ * no libs - except for a single (~2KB) module (include only what you prefer using `extra_javascript`); * supports MkDocs configuration features such as `google_analytics`. -## Install +## Installation * Clone docSkimmer from GitHub: @@ -30,9 +30,11 @@ Or [download the required version](https://github.com/hfagerlund/mkdocs-docskimm * Copy the contents of the `mkdocs_docskimmer` directory into the MkDocs project root (ie. at the same level as the `docs` directory). +## Usage + * Modify the following settings in the 'mkdocs.yml' file: -### For docSkimmer v0.3.x: +### For docSkimmer v0.3.x, v0.4.x: ```yaml # mkdocs.yml: @@ -110,6 +112,7 @@ theme_dir: 'mkdocs_docskimmer' | docSkimmer theme version(s) | MkDocs version(s) | | :------: | :------: | +| 0.4.0 | 1.0.4 | | 0.3.1 | 1.0.4
[Template URL filter addition](https://github.com/mkdocs/mkdocs/tree/decaf6141c90b0123a4b7f03ee839d0780570bc9) | | 0.3.0 | [Pages refactor](https://github.com/mkdocs/mkdocs/tree/34ef3ca6d0390959080ce93a695361eea1649272) | | 0.2.1 | 0.17.4
0.17.3
0.17.2
0.17.1
0.17.0 | diff --git a/docs/404.html b/docs/404.html old mode 100644 new mode 100755 index cf9f45d..abf86ea --- a/docs/404.html +++ b/docs/404.html @@ -91,7 +91,7 @@

☰ open + @@ -140,8 +140,8 @@

404 Page Not Found

\ No newline at end of file diff --git a/docs/css/docskimmer.css b/docs/css/docskimmer.css old mode 100644 new mode 100755 index e54752b..1d15c4c --- a/docs/css/docskimmer.css +++ b/docs/css/docskimmer.css @@ -1,5 +1,5 @@ /* - docSkimmer theme v0.3.1 + docSkimmer theme v0.4.0 License: BSD-2-Clause license (https://github.com/hfagerlund/mkdocs-docskimmer/blob/master/LICENSE) */ @@ -207,7 +207,7 @@ ol ol,ul ul{margin-left:1.5em} /* phone-and-tablet */ @media only screen and (max-width:1199px) { /* BEGIN page TOC menu panel */ - #maincontent{padding:0;transition:margin-left .5s} + .maincontent{padding:0;transition:margin-left .5s} .page-toc{background-color:#eee;border-right:1px solid #999;height:100%;left:0;overflow-x:hidden;position:fixed;top:0;transition:0.5s;width:0;z-index:2} .page-toc__closebtn{border:1px solid #085f5f;font-size:1.4em;margin-top:0.5em;padding:0 0.2em;position:absolute;right:0.5em;text-decoration:none;top:0} .page-toc__heading{margin-left:1em} @@ -216,7 +216,7 @@ ol ol,ul ul{margin-left:1.5em} code{background-color:transparent;border-left:7px solid #eee;border-radius:0} .form__input{min-width:70%;width:auto} - #menu-hamburger{background-color:#222;color:#fff;cursor:pointer;border-radius:25px;float:right;font-size:1.2em;margin:0.5em 0.5em 0 0;padding:0.2em 0.5em} + .menu-hamburger{background-color:#222;color:#fff;cursor:pointer;border-radius:25px;float:right;font-size:1.2em;margin:0.5em 0.5em 0 0;padding:0.2em 0.5em} .page-toc__heading{border-bottom:0;margin-bottom:0;padding-top:2em} .page-toc__item{margin:0} } /* END phone-and-tablet */ @@ -266,8 +266,8 @@ ol ol,ul ul{margin-left:1.5em} /* desktop-up */ @media only screen and (min-width:1200px) { - #maincontent{margin-left:7em;margin-right:19em} - #menu-hamburger,.page-toc__closebtn{display:none} + .maincontent{margin-left:7em;margin-right:19em} + .menu-hamburger,.page-toc__closebtn{display:none} .page-toc{display:block;float:right;position:absolute;top:17em;right:0;margin:0;padding:0.5em 1em 2em 2em;max-width:15em} } diff --git a/docs/examples/another-sample-page/index.html b/docs/examples/another-sample-page/index.html old mode 100644 new mode 100755 index 6a15d2b..5dc30f6 --- a/docs/examples/another-sample-page/index.html +++ b/docs/examples/another-sample-page/index.html @@ -113,11 +113,11 @@

docSk - + -
+

Another sample page

This is another sample page to demonstrate:

    @@ -460,28 +460,28 @@

    Data tables

-