cheatset 1.3.8 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c17d60608527a7bfaf467040fc3f3ff24feeb33e
-  data.tar.gz: 3ec579d38fff206c660ad8de50e318ec5189fd72
+SHA256:
+  metadata.gz: 81813b0cb0456d0585f35a8c2d122cc990a6549e3ceaa1ce017ef308d61d4899
+  data.tar.gz: 65ca0783c3cb8187e3d04000ef52a61827dd8468000ec77d0b758d769dc782ae
 SHA512:
-  metadata.gz: 4403ac5eec70a0d560c5db741ce605e13fa7ac2ef16790e79d78693854edbebb51e669bbf7e141a1e8cb4705ce44f9899b1b1dbbd7b07de8675913b1285dd266
-  data.tar.gz: 23a3021db0729fe6feec2f7e9292b86c9f0f4727e8776604c609365e7b6521733a4213e778ef9c1bd20292d526aba236d509e4a557bfe04afe7fd7bd3ae30763
+  metadata.gz: ce2f280c10e5f1ab13db3230dddc0b23d1867f3bd0f729b5b88ad2ecaecc23dc312f9c97d61e4a3c4171d12c78905fb1def8dfc17e50a7ea2adf3751074c079b
+  data.tar.gz: 23aa5393bfa5d5823c4c1679af21da7fe2f6950f65f6fa5d870eb520c1ce1ca3003b237c41c94a3eb88ec50e729d614fdeeba38c2db3c7838064908865cd43b8

data/README.md

@@ -8,15 +8,15 @@ language (Ruby DSL).
 
 ## Installation
 
-    $ sudo gem install cheatset --no-ri --no-rdoc
+    $ sudo gem install cheatset
 
 Note: this requires the Xcode Command Line Tools to be installed. Install them using this:
 
     $ xcode-select --install
-    
+
 ## Contributions
 
-If you make an useful cheat sheet, please [contribute it](https://github.com/Kapeli/cheatsheets#readme) to Dash.
+If you make a useful cheat sheet, please [contribute it](https://github.com/Kapeli/cheatsheets#readme) to Dash.
 
 ## Usage
 
@@ -28,7 +28,7 @@ cheatsheet do
   docset_file_name 'Sample'    # Used for the filename of the docset
   keyword 'sample'             # Used as the initial search keyword (listed in Preferences > Docsets)
   # resources 'resources_dir'  # An optional resources folder which can contain images or anything else
-  
+
   introduction 'My *awesome* cheat sheet'  # Optional, can contain Markdown or HTML
 
   # A cheat sheet must consist of categories
@@ -78,6 +78,15 @@ Syntax highlighting is supported (see Ruby code in the sample). For a list of su
 For more complete examples look at some of
 [the actual cheat sheets](https://github.com/Kapeli/cheatsheets/tree/master/cheatsheets).
 
+If you do not use Ruby or lack a working Ruby toolchain and still want to generate cheatsheets.
+
+You can use the `cheatset` Docker image.
+
+    $ docker pull jonasbn/cheatset:lastest
+    $ docker run --rm  -it --volume $PWD:/tmp --name cheatset jonasbn/cheatset:latest generate samble.rb
+
+For more details on the Docker image please visit the repositories on [DockerHub](https://hub.docker.com/repository/docker/jonasbn/cheatset) or [GitHub](https://github.com/jonasbn/docker-cheatset)
+
 ## Advanced Usage
 
 Apart from the attributes listed in the sample cheat sheet above, you can also use these:

data/lib/cheatset/creator.rb

@@ -99,20 +99,22 @@ class Cheatset::Creator
         href = (entry.name || entry.index_name) ? "index.html\#//dash_ref_#{category_strip}/Entry/#{URI.escape((entry.index_name) ? entry.index_name.strip : entry.tags_stripped_name.strip).gsub(/\//, '%252F')}/0" : (first_command) ? "index.html\#//dash_ref_#{category_strip}/Command/#{URI.escape(first_command).gsub(/\//, '%252F')}/0" : ""
         if entry.command
           entry.command.each do |command|
-            if(!command.strip.empty?)
+            if(!command.strip.empty? && !entry.not_in_main_index)
               db.execute(sql, command.strip, 'Command', href)
             end
           end
         end
         if entry.td_command
           entry.td_command.each do |command|
-            if(!command.strip.empty?)
+            if(!command.strip.empty? && !entry.not_in_main_index)
               db.execute(sql, command.strip, 'Command', href)
             end
           end
         end
         if entry.name || entry.index_name
-          db.execute(sql, (entry.index_name) ? entry.index_name.strip : entry.tags_stripped_name.strip, 'Entry', href)
+          if(!entry.not_in_main_index)
+            db.execute(sql, (entry.index_name) ? entry.index_name.strip : entry.tags_stripped_name.strip, 'Entry', href)
+          end
         end
         if entry.extra_index_name
           entry.extra_index_name.each do |extra_index_name|

data/lib/cheatset/dsl/entry.rb

@@ -2,7 +2,7 @@ module Cheatset
   module DSL
     class Entry < Base
       define_list_attrs :command, :td_command, :extra_index_name
-      define_attrs :index_name
+      define_attrs :index_name, :not_in_main_index
       define_markdown_attrs :name, :notes
       define_markdown_list_attrs :td_notes
     end

data/lib/cheatset/templates/style.css

@@ -44,14 +44,14 @@ h1, h2, h3, p, blockquote {
   src: local("Open Sans Extrabold Italic"), local("OpenSans-ExtraboldItalic"), url(cheatset_resources/Open_Sans_Extrabold_Italic.woff) format("woff"); }
 body {
   font-family: 'Open Sans', sans-serif;
-  font-size: 14px;
+  font-size: 16px;
   color: #000;
   background-color: #fff;
   margin: 0; }
 
 code, pre {
   font-family: Menlo, Consolas, "Liberation Mono", Courier, monospace;
-  font-size: 13px; }
+  font-size: 15px; }
 
 code {
   margin: 0;

data/lib/cheatset/version.rb

@@ -1,3 +1,3 @@
 module Cheatset
-  VERSION = '1.3.8'
+  VERSION = '1.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheatset
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.2
 platform: ruby
 authors:
 - Bogdan Popescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,8 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Generate cheat sheets for Dash