techdoc-jekyll-theme 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c688960f266201e3158ce41c84054f7547d0c6f0e0a6596b43acab049826e9
-  data.tar.gz: b0321c11924bc08fc96bf757d9ac7abcfda31d2314054fce0fbab7cee7408f8e
+  metadata.gz: 414b7803f9dcb0792d1bcadc6e7635682a98fcb0ed100471fde26d8888729ce2
+  data.tar.gz: 46a9d1b0772a8e40a52e232b8b656c0c0d77036682a6dac810291e00508621a8
 SHA512:
-  metadata.gz: 70a28c479215cfd9abb0b7a6e82402167df013fdf4b55cc1612f978e2da558861f7eddfd6b2dd84fe64962cb00c45806da4f0e0f056602de350b35f70494c6de
-  data.tar.gz: 5147e2c81f4b30fad653796f2f49d8ab4501cd10bb96027b5df882fdecc7a733b5ddc30400ba58e49f391f010675644db10a0b4eb048bbee78b732e38be6f805
+  metadata.gz: a0021b0ef47f529db6b45139fe78b71c17d2b3684bf9326b01bbe6f02a9dd72742cecae432fd088bc6c35f636ab92a0f6e197e8a6b45f8ec6ec0d513879b68b4
+  data.tar.gz: 18635b2c8088df0a9c2aa2d51c1a46c0af66a0c2a704df6b2e9228c6b86cc2267ba228bc79d7cff87d1634f443dc09b8d83b3375057b78aa4b6e17425179ecf2

data/README.md

@@ -1,52 +1,26 @@
 # TechDoc
+[![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](/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.
@@ -55,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/_config.yml

@@ -4,6 +4,7 @@ github_username: jianmin-chen
 library_name: TechDoc
 library_description: >-
     Jekyll theme for writing technical documentation
+library_link: https://github.com/jianmin-chen/techdoc
 url: "https://jianmin-chen.github.io"
 plugins_dir:
     -jekyll-remote-theme

data/_layouts/default.html

@@ -15,7 +15,9 @@
                 <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>
-                    <!-- Pages -->
+                    {%- 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>

data/assets/css/style.css

@@ -45,6 +45,7 @@ a:hover {opacity: 0.8;}
     color: white;
     display: block;
     font-size: 5rem;
+    word-wrap: break-word;
 }
 
 .text-muted {color: #6c757d;}
@@ -126,6 +127,7 @@ a:hover {opacity: 0.8;}
 .content :not(pre) > code {
     color: #dc3545;
     font-size: 1rem;
+    word-wrap: break-word;
 }
 
 .content pre > code {
@@ -133,6 +135,7 @@ a:hover {opacity: 0.8;}
             box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.4);
     font-size: 0.95rem;
     padding: 15px 30px;
+    white-space: pre-wrap;
 }
 
 .content table {
@@ -154,7 +157,7 @@ a:hover {opacity: 0.8;}
 .footer {
     border-top: 1px solid #dee2e6;
     color: #808080;
-    margin: 15px;
+    margin: 45px 15px 15px 15px;
     padding: 15px;
     text-align: center;
 }
@@ -171,6 +174,7 @@ a:hover {opacity: 0.8;}
 /* Styling for mobile */
 @media screen and (max-width: 991px) {
     .display-1  {margin: 2rem 0;}
+    .display-1 a {font-size: 3.5rem;}
 
     .row {display: block;}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: techdoc-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - jianmin-chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll