techdoc-jekyll-theme 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fca94f611a9b2541753d34355148cd360dc1e84e88c1767386517fc86f91c3a6
-  data.tar.gz: 67d09d69bfbbafb0bc60a94e670b623a92cbeae4877148e9b0185618db185f6f
+  metadata.gz: 176473bfdf1dcf5efe2d3bc9f70b69c5fd2d0053aed878e30070aa7fe28e0cc5
+  data.tar.gz: 8b73f5fe0493ab8e31ea0b7128b75e8e409560bd006bcaf8fa7bea2f9a51c501
 SHA512:
-  metadata.gz: 3288f75f9ca0026c89b9f7c15300f885f4517ef23db2f499efd46324b31be36f0d2ac93b3d744bdcaab8a90d390b2ff2130339fd1ff0668e4737c067748b502d
-  data.tar.gz: 3074c2b1290e16c5b0f83d391c88c18f81a4201fedc9ec99b9a80152a07a6606a14dc42e98d87fee940e3efa7dcf497e041e2e401f5b0aa64ef6ee8bc2d0d028
+  metadata.gz: 925dd93633a0c5eb9d5ddca5a795ddefb58809690f0629a401eb7334d4e8072f310a9fef1217842db2cfc690fabdd0e0545598c21424d6a8a0734cfa4e27869a
+  data.tar.gz: bd03c8d1b6a10faf45a3b0fff7118708a7a1121d3f9cf37175e886a2f26efe4f9711c81cdbcd90bc81d311b9a67e1d56f5a0c9126f1a8dbe4cc9ef97e097f843

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jianmin Chen
+
+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 NONINFRINGEMENT. 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.

data/README.md

@@ -2,52 +2,25 @@
 [![Gem Version](https://badge.fury.io/rb/techdoc-jekyll-theme.svg)](https://badge.fury.io/rb/techdoc-jekyll-theme)
 
 ## About
-
 TechDoc is a Jekyll theme designed for writing technical documentation. The templates that come with it are very minimal, so you can quickly get started writing documentation.
 
 ## Installation
-
-Add this line to your Jekyll site's `Gemfile`:
-
-```ruby
-gem "techdoc"
-```
-
-And add this line to your Jekyll site's `_config.yml`:
-
-```yaml
-theme: techdoc
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install techdoc
+Take a look at this [page](http://jianmin-chen.github.io/techdoc/2021/04/01/using-this-theme.html), which contains detailed instructions for installation.
 
 ## Usage
-
-Once you've installed the theme using the instructions above, you can start writing technical documentation right away by creating a new `.markdown` file in the `/posts` folder. The file should be named `year-month-day-title.markdown`, and the beginning of the file should look something like this:
-
+Once you've installed the theme using the page mentioned above, you can start writing technical documentation right away by creating a new `.markdown` file in the `/posts` folder. The file should be named `year-month-day-title.markdown`, and the beginning of the file should look something like this:
 ```markdown
 ---
 title: <title>
 layout: post
 ---
 ```
-
 Once you've got that, you can start writing away! A quick reference on writing content in Markdown can be found [here](https://kramdown.gettalong.org/quickref.html).
 
-For a more in-depth tutorial, visit the the theme demo.
-
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/jianmin-chen/techdoc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jianmin-chen/techdoc](https://github.com/jianmin-chen/techdoc). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Development
-
 To set up your environment to develop this theme, run `bundle install`.
 
 Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
@@ -56,5 +29,4 @@ When your theme is released, only the files in `_layouts`, `_includes`, `_sass`
 To add a custom directory to your theme-gem, please edit the regexp in `techdoc.gemspec` accordingly.
 
 ## License
-
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_layouts/default.html

@@ -5,7 +5,8 @@
         <meta charset="UTF-8">
         <meta http-equiv="X-UA-Compatible" content="IE=edge">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        <link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append:site.github.build_revision | relative_url }}">
+        <link rel="stylesheet" href="{{ "/assets/css/styles.css?v=" | append:site.github.build_revision | relative_url }}">
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.7.1/build/styles/default.min.css">
         <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.7.1/build/highlight.min.js"></script>
         <script>hljs.highlightAll();</script>
     </head>
@@ -13,14 +14,18 @@
         <div class="row">
             <nav class="col menu">
                 <div class="menu-content">
-                    <h1 class="display-1"><a href="{{ "/" | absolute_url }}">{{ site.library_name }}</a></h1>
-                    <p class="text-muted">{{ site.library_description }}</p>
-                    <a class="nav-link" href="{{ site.library_link }}">Source Code</a>
-                    {%- if site.posts.size > 0 -%}
-                        {%- for post in site.posts -%}
-                            <a class="nav-link" href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
-                        {%- endfor -%}
-                    {%- endif -%}
+                    <div>
+                        <h1 class="display-1"><a href="{{ "/" | absolute_url }}">{{ site.library_name }}</a></h1>
+                        <p class="text-muted">{{ site.library_description }}</p>
+                        {%- if site.library_link -%}
+                            <a class="nav-link" href="{{ site.library_link }}">Source Code</a>
+                        {%- endif -%}
+                        {%- if site.posts.size > 0 -%}
+                            {%- for post in site.posts -%}
+                                <a class="nav-link" href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
+                            {%- endfor -%}
+                        {%- endif -%}
+                    </div>
                 </div>
             </nav>
             <div class="col content-container">

data/assets/css/styles.css

@@ -0,0 +1,287 @@
+/* Import Google Fonts */
+@import url('https://fonts.googleapis.com/css2?family=Fira+Code&family=Roboto&family=Playfair+Display&display=swap');
+
+:root {
+    --main-theme-color: #454545;
+    --text-color: #6c757d;
+}
+
+* {
+    -webkit-box-sizing: border-box;
+    box-sizing: border-box;
+}
+
+/*
+ * Basic setup for body
+ */
+body, html {
+    font-family: "Roboto", sans-serif;
+    margin: 0;
+    padding: 0;
+    min-height: 100vh;
+}
+
+img {
+    width: 100%;
+}
+
+/*
+ * Basic typography setup
+ */
+a {
+    color: var(--text-color);
+    font-size: 0.995rem;
+    margin: 5px 0;
+    text-decoration: none;
+    -webkit-transition: opacity 0.2s;
+    -o-transition: opacity 0.2s;
+    transition: opacity 0.2s;
+}
+a:hover {
+    opacity: 0.8;
+}
+
+code {
+    font-family: "Fira Code", monospace;
+}
+
+.display-1 {
+    font-family: "Playfair Display", sans-serif;
+    margin-top: 4rem;
+}
+.display-1 a {
+    color: white;
+    display: block;
+    font-size: 5rem;
+    word-wrap: break-word;
+}
+
+.text-muted {
+    color: #6c757d;
+}
+
+/*
+ * Flex layout
+ */
+ .row {
+     display: -webkit-box;
+     display: -ms-flexbox;
+     display: flex;
+}
+
+/*
+ * Styles for menu
+ */
+.menu {
+    background-color: var(--main-theme-color);
+    -webkit-box-flex: 1;
+        -ms-flex: 1;
+            flex: 1;
+}
+
+.menu .menu-content {
+    -webkit-box-align: end;
+        -ms-flex-align: end;
+            align-items: flex-end;
+    color: white;
+    display: -webkit-box;
+    display: -ms-flexbox;
+    display: flex;
+    font-size: 1.2rem;
+    padding: 45px;
+    position: -webkit-sticky;
+    position: sticky;
+    top: 0;
+    left: 0;
+    height: 100vh;
+}
+
+/* Navigation links */
+.menu .nav-link {
+    color: white;
+    display: block;
+}
+
+/*
+ * Styles for content
+ */
+.content-container {
+    -webkit-box-flex: 3;
+        -ms-flex: 3;
+            flex: 3;
+    padding: 30px 60px;
+}
+
+.content {
+    color: #808080;
+    line-height: 1.5;
+}
+
+.content a {font-size: 0.995rem;}
+
+.content blockquote {
+    background-color: #f1f1f1;
+    color: var(--text-color);
+    margin: 0;
+    padding: 15px 30px;
+}
+
+.content dt {font-weight: 800;}
+
+.content h1, .content h2, .content h3, .content h4, .content h5, .content h6 {
+    border-bottom: 1px solid #f1f1f1;
+    color: gray;
+    font-weight: 400;
+    margin: 15px 0;
+    padding: 5px 0;
+}
+
+.content h1 {
+    font-size: 2.5rem;
+}
+.content h2 {
+    font-size: 2.4rem;
+}
+.content h3 {
+    font-size: 2.3rem;
+}
+.content h4 {
+    font-size: 2.2rem;
+}
+.content h5 {
+    font-size: 2.1rem;
+}
+.content h6 {
+    font-size: 2rem;
+}
+
+.content h1:before, .content h2:before, .content h3:before, .content h4:before, .content h5:before, .content h6:before {
+    color: #ccc;
+    margin-right: 10px;
+}
+.content h1:before {
+    content: "#";
+    font-size: 2.2rem;
+}
+.content h2:before {
+    content: "##";
+    font-size: 2.1rem;
+}
+.content h3:before {
+    content: "###";
+    font-size: 2rem;
+}
+.content h4:before {
+    content: "####";
+    font-size: 1.9rem;
+}
+.content h5:before {
+    content: "#####";
+    font-size: 1.8rem;
+}
+.content h6:before {
+    content: "######";
+    font-size: 1.7rem;
+}
+
+.content :not(pre) > code {
+    color: #dc3545;
+    font-size: 0.995rem;
+    word-wrap: break-word;
+}
+
+.content pre > code {
+    font-size: 0.95rem;
+    padding: 15px 30px;
+    white-space: pre-wrap;
+}
+
+.content table {
+    border: 1px solid #f1f1f1;
+    border-collapse: collapse;
+    overflow-x: scroll;
+    min-width: 100%;
+}
+
+.content thead > tr, .content tr:nth-child(even) {
+    background-color: #f1f1f1;
+}
+
+.content th {
+    font-weight: 700;
+}
+.content th, .content td {
+    padding: 14px 28px;
+    text-align: left !important;
+}
+
+.content ul {
+    margin: 0;
+}
+
+/*
+ * Styles for footer
+ */
+.footer {
+    border-top: 1px solid #dee2e6;
+    color: #808080;
+    margin: 45px 0 15px 0;
+    padding: 15px;
+    text-align: center;
+}
+
+/* Styling for desktop */
+@media screen and (min-width: 1200px) {
+    .content-container {
+        padding: 60px 120px;
+    }
+}
+
+@media screen and (min-width: 992px) {
+    .menu {
+        min-height: 100vh;
+    }
+
+    .content-container {
+        -webkit-box-shadow: 0 4px 8px 0 var(--main-theme-color);
+                box-shadow: 0 4px 8px 0 var(--main-theme-color);
+    }
+}
+
+/* Styling for mobile */
+@media screen and (max-width: 991px) {
+    .display-1  {
+        margin: 2rem 0;
+    }
+
+    .row {
+        display: block;
+    }
+
+    .menu .menu-content {
+        padding: 25px;
+    }
+
+    .content-container {
+        padding: 25px;
+    }
+
+    .content h1 {
+        font-size: 2rem;
+    }
+    .content h2 {
+        font-size: 1.95rem;
+    }
+    .content h3 {
+        font-size: 1.9rem;
+    }
+    .content h4 {
+        font-size: 1.85rem;
+    }
+    .content h5 {
+        font-size: 1.8rem;
+    }
+    .content h6 {
+        font-size: 1.75rem;
+    }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: techdoc-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - jianmin-chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -59,12 +59,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - _config.yml
 - _layouts/default.html
 - _layouts/post.html
-- assets/css/hljs-theme.css
-- assets/css/style.css
+- assets/css/styles.css
 homepage: https://jianmin-chen.github.io/techdoc/
 licenses:
 - MIT

data/assets/css/hljs-theme.css

@@ -1,154 +0,0 @@
-.hljs {
-    background: #2e3440;
-    display: block;
-    overflow-x: auto;
-    padding: 0.5em;
-}
-
-.hljs, .hljs-subst {color: #d8dee9;}
-
-.hljs-selector-tag {color: #81a1c1;}
-
-.hljs-selector-id {
-    color: #8fbcbb;
-    font-weight: 700;
-}
-
-.hljs-selector-class {color: #8fbcbb;}
-
-.hljs-selector-attr {color: #8fbcbb;}
-
-.hljs-selector-pseudo {color: #88c0d0;}
-
-.hljs-addition {background-color: rgba(163,190,140,.5);}
-
-.hljs-deletion {background-color: rgba(191,97,106,.5);}
-
-.hljs-built_in,.hljs-type {color: #8fbcbb;}
-
-.hljs-class {color: #8fbcbb;}
-
-.hljs-function {color: #88c0d0;}
-
-.hljs-function > .hljs-title {color: #88c0d0;}
-
-.hljs-keyword, .hljs-literal, .hljs-symbol {color: #81a1c1;}
-
-.hljs-number {color: #b48ead;}
-
-.hljs-regexp {color: #ebcb8b;}
-
-.hljs-string {color: #a3be8c;}
-
-.hljs-title {color: #8fbcbb;}
-
-.hljs-params {color: #d8dee9;}
-
-.hljs-bullet {color: #81a1c1;}
-
-.hljs-code {color: #8fbcbb;}
-
-.hljs-emphasis {font-style: italic;}
-
-.hljs-formula {color: #8fbcbb;}
-
-.hljs-strong {font-weight: 700;}
-
-.hljs-link:hover {text-decoration: underline;}
-
-.hljs-quote {color: #4c566a;}
-
-.hljs-comment {color: #4c566a;}
-
-.hljs-doctag {color: #8fbcbb;}
-
-.hljs-meta, .hljs-meta-keyword {color: #5e81ac;}
-
-.hljs-meta-string {color: #a3be8c;}
-
-.hljs-attr {color: #8fbcbb;}
-
-.hljs-attribute {color: #d8dee9;}
-
-.hljs-builtin-name {color: #81a1c1;}
-
-.hljs-name {color: #81a1c1;}
-
-.hljs-section {color: #88c0d0;}
-
-.hljs-tag {color: #81a1c1;}
-
-.hljs-variable {color: #d8dee9;}
-
-.hljs-template-variable {color: #d8dee9;}
-
-.hljs-template-tag {color: #5e81ac;}
-
-.abnf .hljs-attribute {color: #88c0d0;}
-
-.abnf .hljs-symbol {color: #ebcb8b;}
-
-.apache .hljs-attribute {color: #88c0d0;}
-
-.apache .hljs-section {color: #81a1c1;}
-
-.arduino .hljs-built_in {color: #88c0d0;}
-
-.aspectj .hljs-meta {color: #d08770;}
-
-.aspectj > .hljs-title {color: #88c0d0;}
-
-.bnf .hljs-attribute {color: #8fbcbb;}
-
-.clojure .hljs-name {color: #88c0d0;}
-
-.clojure .hljs-symbol {color: #ebcb8b;}
-
-.coq .hljs-built_in {color: #88c0d0;}
-
-.cpp .hljs-meta-string {color: #8fbcbb;}
-
-.css .hljs-built_in {color: #88c0d0;}
-
-.css .hljs-keyword {color: #d08770;}
-
-.diff .hljs-meta {color: #8fbcbb;}
-
-.ebnf .hljs-attribute {color: #8fbcbb;}
-
-.glsl .hljs-built_in {color: #88c0d0;}
-
-.groovy .hljs-meta:not(:first-child) {color: #d08770;}
-
-.haxe .hljs-meta {color: #d08770;}
-
-.java .hljs-meta {color: #d08770;}
-
-.ldif .hljs-attribute {color: #8fbcbb;}
-
-.lisp .hljs-name {color: #88c0d0;}
-
-.lua .hljs-built_in {color: #88c0d0;}
-
-.moonscript .hljs-built_in {color: #88c0d0;}
-
-.nginx .hljs-attribute{color: #88c0d0}
-
-.nginx .hljs-section {color: #5e81ac;}
-
-.pf .hljs-built_in {color:#88c0d0;}
-
-.processing .hljs-built_in {color: #88c0d0;}
-
-.scss .hljs-keyword {color: #81a1c1;}
-
-.stylus .hljs-keyword {color: #81a1c1;}
-
-.swift .hljs-meta {color: #d08770;}
-
-.vim .hljs-built_in {
-    color: #88c0d0;
-    font-style:italic;
-}
-
-.yaml .hljs-meta {color: #d08770;}

data/assets/css/style.css

@@ -1,190 +0,0 @@
-/* Import Google Fonts */
-@import url('https://fonts.googleapis.com/css2?family=Noto+Sans:wght@400;700&family=Open+Sans:wght@400;700&display=swap');
-
-/* Import highlight.js theme */
-@import "hljs-theme.css";
-
-:root {
-    --main-theme-color: #273036;
-    --text-color: #6c757d;
-}
-
-* {
-    -webkit-box-sizing: border-box;
-    box-sizing: border-box;
-}
-
-/*
- * Basic setup for body
- */
-body, html {
-    font-family: "Noto Sans", sans-serif;
-    margin: 0;
-    padding: 0;
-    min-height: 100vh;
-}
-
-img {width: 100%;}
-
-/*
- * Basic typography setup
- */
-a {
-    color: var(--text-color);
-    font-size: 0.95rem;
-    margin: 5px 0;
-    text-decoration: none;
-    -webkit-transition: opacity 0.2s;
-    -o-transition: opacity 0.2s;
-    transition: opacity 0.2s;
-}
-a:hover {opacity: 0.8;}
-
-.display-1 {margin: 4rem 0;}
-.display-1 a {
-    color: white;
-    display: block;
-    font-size: 5rem;
-    word-wrap: break-word;
-}
-
-.text-muted {color: #6c757d;}
-
-/*
- * Flex layout
- */
- .row {
-     display: -webkit-box;
-     display: -ms-flexbox;
-     display: flex;
-}
-
-/*
- * Styles for menu
- */
-.menu {
-    background-color: var(--main-theme-color);
-    -webkit-box-flex: 1;
-        -ms-flex: 1;
-            flex: 1;
-}
-
-.menu .menu-content {
-    color: white;
-    font-size: 1.2rem;
-    padding: 45px;
-    position: -webkit-sticky;
-    position: sticky;
-    top: 0;
-    left: 0;
-}
-
-/* Navigation links */
-.menu .nav-link {
-    color: white;
-    display: block;
-}
-
-/*
- * Styles for content
- */
-.content-container {
-    -webkit-box-flex: 2;
-        -ms-flex: 2;
-            flex: 2;
-    padding: 45px;
-}
-
-.content {
-    color: #242526;
-    line-height: 1.5;
-    font-family: "Open Sans", sans-serif;
-}
-
-.content a {font-size: 0.995rem;}
-
-.content blockquote {
-    border-left: 0.3rem solid var(--text-color);
-    color: var(--text-color);
-    margin: 0;
-    padding: 0 1rem;
-}
-
-.content dt {font-weight: 800;}
-
-.content h1, .content h2, .content h3, .content h4, .content h5, .content h6 {
-    color: var(--text-color);
-    font-weight: 400;
-    margin: 15px 0;
-}
-.content h1 {font-size: 2.5rem;}
-.content h2 {font-size: 2.4rem;}
-.content h3 {font-size: 2.3rem;}
-.content h4 {font-size: 2.2rem;}
-.content h5 {font-size: 2.1rem;}
-.content h6 {font-size: 2rem;}
-
-.content :not(pre) > code {
-    color: #dc3545;
-    font-size: 1rem;
-    word-wrap: break-word;
-}
-
-.content pre > code {
-    -webkit-box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.4);
-            box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.4);
-    font-size: 0.95rem;
-    padding: 15px 30px;
-}
-
-.content table {
-    border-collapse: collapse;
-    overflow-x: scroll;
-}
-
-.content thead > tr, .content tr:nth-child(even) {background-color: #dee2e6;}
-
-.content th {font-weight: 700;}
-.content th, .content td {
-    padding: 7px 14px;
-    text-align: left !important;
-}
-
-/*
- * Styles for footer
- */
-.footer {
-    border-top: 1px solid #dee2e6;
-    color: #808080;
-    margin: 15px;
-    padding: 15px;
-    text-align: center;
-}
-
-/* Styling for desktop */
-@media screen and (min-width: 992px) {
-    .menu {
-        -webkit-box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.7);
-                box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.7);
-        min-height: 100vh;
-    }
-}
-
-/* Styling for mobile */
-@media screen and (max-width: 991px) {
-    .display-1  {margin: 2rem 0;}
-    .display-1 a {font-size: 3.5rem;}
-
-    .row {display: block;}
-
-    .menu .menu-content {padding: 25px;}
-
-    .content-container {padding: 25px;}
-
-    .content h1 {font-size: 2rem;}
-    .content h2 {font-size: 1.95rem;}
-    .content h3 {font-size: 1.9rem;}
-    .content h4 {font-size: 1.85rem;}
-    .content h5 {font-size: 1.8rem;}
-    .content h6 {font-size: 1.75rem;}
-}