Merge pull request #86 from pmarsceill/v0.2.3

v0.2.3 Release Branch

_config.yml

@@ -16,7 +16,7 @@
 title: Just the Docs
 description: A Jekyll theme for documentation
 baseurl: "/just-the-docs/" # the subpath of your site, e.g. /blog
-# url: "" # the base hostname & protocol for your site, e.g. http://example.com
+url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 
 permalink: pretty
 exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json",  "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
@@ -31,3 +31,7 @@ aux_links:
 
 # Color scheme currently only supports "dark" or nil (default)
 color_scheme: nil
+
+# Google Analytics Tracking (optional)
+# e.g, UA-1234567-89
+ga_tracking: UA-2709176-10

_includes/head.html

@@ -7,8 +7,18 @@
 
   <title>{{ page.title }} - {{ site.title }}</title>
   <link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
+
+  {% if site.ga_tracking != nil %}
+    <script>
+      window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
+      ga('create', '{{ site.ga_tracking }}', '{{ site.url }}');
+      ga('send', 'pageview');
+    </script>
+    <script async src="https://www.google-analytics.com/analytics.js"></script>
+  {% endif %}
+
   {% if site.search_enabled != nil %}
-  <script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
+    <script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
   {% endif %}
   <script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
 

_layouts/default.html

@@ -15,7 +15,7 @@
         <p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
       </footer>
     </div>
-    <div class="main-content-wrap">
+    <div class="main-content-wrap js-main-content" tabindex="0">
       <div class="page-header">
         <div class="main-content">
           {% if site.search_enabled != nil %}
@@ -36,7 +36,7 @@
           {% endif %}
         </div>
       </div>
-      <div class="main-content js-main-content" tabindex="0">
+      <div class="main-content">
         {% unless page.url == "/" %}
           {% if page.parent %}
             <nav class="breadcrumb-nav">

_sass/content.scss

@@ -21,13 +21,13 @@
     list-style-type: none;
     counter-reset: step-counter;
 
-    li {
+    > li {
       position: relative;
 
       &::before {
         position: absolute;
         top: 0.2em;
-        left: -1.5em;
+        left: -1.6em;
         color: $grey-dk-000;
         content: counter(step-counter);
         counter-increment: step-counter;
@@ -54,10 +54,10 @@
   ul {
     list-style: none;
 
-    li {
+    > li {
       &::before {
         position: absolute;
-        margin-left: -1.5em;
+        margin-left: -1.4em;
         color: $grey-dk-000;
         content: "•";
       }

assets/js/just-the-docs.js

@@ -54,7 +54,7 @@ function initSearch() {
 
   jsPath = source.replace('just-the-docs.js', '');
 
-  jsonPath = jsPath + '/search-data.json';
+  jsonPath = jsPath + 'search-data.json';
 
   var request = new XMLHttpRequest();
   request.open('GET', jsonPath, true);
@@ -108,7 +108,7 @@ function initSearch() {
       } else {
         var results = index.search(query);
 
-        if (results.length > 1) {
+        if (results.length > 0) {
           searchResults.classList.add('active');
           var resultsList = document.createElement('ul');
           searchResults.appendChild(resultsList);

docs/configuration.md

@@ -5,8 +5,22 @@ nav_order: 2
 ---
 
 # Configuration
+{: .no_toc }
 
-Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's `_config.yml` file.
+
+Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's _config.yml file.
+{: .fs-6 .fw-300 }
+
+## Table of contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
+---
+
+
+View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
 
 ## Search enabled
 
@@ -48,3 +62,11 @@ addEvent(toggleDarkMode, 'click', function(){
 </script>
 
 See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.
+
+## Google Analytics
+
+```yaml
+# Google Analytics Tracking (optional)
+# e.g, UA-1234567-89
+ga_tracking: UA-5555555-55
+```

docs/index-test.md

@@ -94,6 +94,24 @@ end
   - level 2 item
 - level 1 item
 
+### Nesting an ol in ul in an ol
+
+- level 1 item (ul)
+  1. level 2 item (ol)
+  1. level 2 item (ol)
+    - level 3 item (ul)
+    - level 3 item (ul)
+- level 1 item (ul)
+  1. level 2 item (ol)
+  1. level 2 item (ol)
+    - level 3 item (ul)
+    - level 3 item (ul)
+  1. level 4 item (ol)
+  1. level 4 item (ol)
+    - level 3 item (ul)
+    - level 3 item (ul)
+- level 1 item (ul)
+
 ### And a task list
 
 - [ ] Hello, this is a TODO item

docs/utilities/layout.md

@@ -105,8 +105,8 @@ This button will be hidden until medium screen sizes:
 These headings will be `inline-block`:
 
 ### heading 3
-{ .d-inline-block }
+{: .d-inline-block }
 
 ### heading 3
-{ .d-inline-block }
+{: .d-inline-block }
 ```

index.md

@@ -66,7 +66,7 @@ $ bundle exec jekyll serve
 
 ## About the project
 
-Just the Docs is © 2017 by [Patrick Marsceill](http://patrickmarsceill.com).
+Just the Docs is © 2017-2019 by [Patrick Marsceill](http://patrickmarsceill.com).
 
 ### License
 

just-the-docs.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "just-the-docs"
-  spec.version       = "0.2.2"
+  spec.version       = "0.2.3"
   spec.authors       = ["Patrick Marsceill"]
   spec.email         = ["patrick.marsceill@gmail.com"]
 
-  spec.summary       = %q{A nice looking, highly customizable, responsive Jekyll theme for documentation with built-in search.}
+  spec.summary       = %q{A modern, high customizable, responsive Jekyll theme for documention with built-in search.}
   spec.homepage      = "https://github.com/pmarsceill/just-the-docs"
   spec.license       = "MIT"
 

lib/tasks/search.rake

@@ -14,7 +14,7 @@ namespace :search do
 {
   {% for page in site.html_pages %}{% if page.search_exclude != true %}"{{ forloop.index0 }}": {
     "id": "{{ forloop.index0 }}",
-    "title": "{{ page.title | replace: '&', '&' }}",
+    "title": "{{ page.title | replace: \'&\', \'&\' }}",
     "content": "'+content+'",
     "url": "{{ page.url | absolute_url }}",
     "relUrl": "{{ page.url }}"

package.json

@@ -1,12 +1,12 @@
 {
   "name": "just-the-docs",
-  "version": "0.2.2",
+  "version": "0.2.3",
-  "description": "A Jekyll theme for documentation",
+  "description": "A modern Jekyll theme for documentation",
   "repository": "pmarsceill/just-the-docs",
   "license": "MIT",
   "bugs": "https://github.com/pmarsceill/just-the-docs/issues",
   "devDependencies": {
-    "stylelint": "^9.9.0",
+    "stylelint": "^9.10.1",
     "stylelint-config-primer": "^3.0.1"
   },
   "dependencies": {},