jekyll-latex-pdf 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3e64ce2d3f03984f249c185edaa31dcdb03270f
-  data.tar.gz: 0a2f6ba85b753252c292d0fc8ebe4d1b32ee3e80
+  metadata.gz: 9a737aeb75c5bf4341c37833d7e6e7cb6bd51968
+  data.tar.gz: 3846bef0d7656169b8aff77026e0b285364ab3f7
 SHA512:
-  metadata.gz: 517ab1602eec6a55fa7ce0db5887885ff1ac9be7a76003d1389d219fdf65ee3a7c7509330b6aa1cbaff6f23eee16ef2424a38e134974eb6600f0f9ff40a9c593
-  data.tar.gz: 40f6b2b970b29046263cccae9a66f40a7e678963dd705e40c19ce01390dc1754f31a2459b4224bfb8a96a4c467a5e247633137a527c63757416725f34d1f0684
+  metadata.gz: 4f9ef3d40712ace907e58ef4c647a55d1047d87bb32cf084eec2ce3ccc2eceb993c96437f32627907784ab05816fb7aeab8b1c1545c21adff7d2818e9c17af57
+  data.tar.gz: 74b082a6f6f51e729ccd4aa59c70fb22af8e43c680883d219abd39d8b8b1fc317197c6e4b864122d6a74a11d60280c120214802429c054aa30a5270f874a4e94

data/.rubocop.yml

@@ -1,162 +1,215 @@
----
-
-require:
-  - ./rubocop/jekyll
-
-Jekyll/NoPutsAllowed:
-  Exclude:
-    - rake/*.rake
-
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Include:
+    - bin/*
     - lib/**/*.rb
-    - test/**/*.rb
-  Exclude:
-    - bin/**/*
-    - exe/**/*
-    - benchmark/**/*
-    - script/**/*
-    - vendor/**/*
-    - tmp/**/*
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
-Layout/IndentationWidth:
-  Severity: error
-Layout/IndentArray:
-  EnforcedStyle: consistent
-Layout/IndentHash:
-  EnforcedStyle: consistent
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-Lint/NestedPercentLiteral:
-  Exclude:
-    - test/test_site.rb
-Layout/EmptyComment:
-  Enabled: false
-Layout/EndAlignment:
-  Severity: error
-Lint/UnreachableCode:
-  Severity: error
-Lint/Void:
-  Exclude:
-    - lib/jekyll/site.rb
-Metrics/AbcSize:
-  Max: 21
-Metrics/BlockLength:
-  Exclude:
-    - test/**/*.rb
-    - lib/jekyll/configuration.rb
-    - rake/*.rake
-Metrics/ClassLength:
-  Exclude:
-    - !ruby/regexp /features\/.*.rb$/
-    - !ruby/regexp /test\/.*.rb$/
-    - lib/jekyll/document.rb
-    - lib/jekyll/site.rb
-    - lib/jekyll/commands/serve.rb
-    - lib/jekyll/configuration.rb
-  Max: 240
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - lib/jekyll/utils.rb
-    - lib/jekyll/commands/serve.rb
+
+
+
 Metrics/LineLength:
-  Exclude:
-    - !ruby/regexp /features\/.*.rb/
-    - Rakefile
-    - rake/*.rake
-    - Gemfile
-  Max: 120
-  Severity: warning
-Metrics/MethodLength:
-  CountComments: false
-  Max: 20
-  Severity: error
-Metrics/ModuleLength:
-  Max: 240
+  Max: 110 # Preferred length is 100
+
 Metrics/ParameterLists:
-  Max: 4
-Metrics/PerceivedComplexity:
+  CountKeywordArgs: false
   Max: 8
-Naming/FileName:
+
+Metrics/BlockLength:
   Enabled: false
-Naming/HeredocDelimiterNaming:
-  Exclude:
-    - test/**/*.rb
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - lib/jekyll/convertible.rb
-    - lib/jekyll/drops/site_drop.rb
-    - lib/jekyll/drops/unified_payload_drop.rb
-    - lib/jekyll/page_without_a_file.rb
-Security/MarshalLoad:
-  Exclude:
-    - !ruby/regexp /test\/.*.rb$/
-    - lib/jekyll/regenerator.rb
-Security/YAMLLoad:
-  Exclude:
-    - !ruby/regexp /features\/.*.rb/
-    - !ruby/regexp /test\/.*.rb$/
-Style/AccessModifierDeclarations:
+
+Metrics/MethodLength:
   Enabled: false
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-Style/AndOr:
-  Severity: error
-Style/ClassAndModuleChildren:
-  Exclude:
-    - test/**/*.rb
-Style/ClassVars:
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
   Enabled: false
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
-Style/Documentation:
+
+Metrics/AbcSize:
   Enabled: false
-Style/DoubleNegation:
+
+Metrics/CyclomaticComplexity:
   Enabled: false
-Style/FormatStringToken:
-  Exclude:
-    - lib/jekyll/utils/ansi.rb
-Style/GuardClause:
+
+Metrics/PerceivedComplexity:
   Enabled: false
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-  Severity: error
-Style/MixinUsage:
-  Exclude:
-    - test/helper.rb
-Style/ModuleFunction:
-  Enabled: false
-Style/MultilineTernaryOperator:
-  Severity: error
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%q": "{}"
-    "%Q": "{}"
-    "%r": "!!"
-    "%s": "()"
-    "%w": "()"
-    "%W": "()"
-    "%x": "()"
-Style/RegexpLiteral:
-  EnforcedStyle: percent_r
-Style/RescueModifier:
+
+Metrics/BlockNesting:
+  Max: 5
+
+
+Style/Encoding:
   Enabled: false
-Style/SafeNavigation:
-  Exclude:
-    - lib/jekyll/document.rb
-Style/SignalException:
-  EnforcedStyle: only_raise
+
 Style/StringLiterals:
-  EnforcedStyle: double_quotes
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+  Enabled: false # we don't care
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/NumericLiteralPrefix:
+  EnforcedOctalStyle: zero_only
+
 Style/SymbolArray:
   EnforcedStyle: brackets
+
+Style/WordArray:
+  MinSize: 5
+
 Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: consistent_comma
+  EnforcedStyleForMultiline: comma
+
 Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma
+  EnforcedStyleForMultiline: comma
+
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/Lambda:
+  EnforcedStyle: lambda
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/YodaCondition:
+  EnforcedStyle: require_for_equality_operators_only
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false # false alarms
+
+Style/MethodMissingSuper:
+  Enabled: false # why the need to fallback to super?
+
+Style/Next:
+  Enabled: false # not really useful
+
+Style/ParallelAssignment:
+  Enabled: false # not really needed
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false # compact nested ternary operators are okay
+
+Style/RescueModifier:
+  Enabled: false # valid but using it makes life sometimes easier
+
+Style/MutableConstant:
+  Enabled: false # valid but sometimes unavoidable
+
+Style/CommentedKeyword:
+  Enabled: false # false alarms and we do want yield comments on that line
+
+Style/StderrPuts:
+  Enabled: false # false alarms because not all $stderr.puts messages are Ruby style warnings
+
+Style/PerlBackrefs:
+  Enabled: false # sometimes there are no good alternatives
+
+Style/IfUnlessModifier:
+  Enabled: false # useful but sometimes the meaning is better conveyed using an if/unless statement
+
+Style/InfiniteLoop:
+  Enabled: false # why should Kernel#loop be better than while true?
+
+Style/SpecialGlobalVars:
+  Enabled: false # I think that $! and $? are recognizable in terms of their function
+
+Style/MultipleComparison:
+  Enabled: false # why should an array be created? especially if only two items are compared
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false # I prefer to use either one or the other, depending on context
+
+Style/FormatStringToken:
+  Enabled: false # I don't care about this
+
+#Style/ClassAndModuleChildren:
+#  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+
+Layout/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false # we have the magic comment and then the license
+
+Layout/IndentAssignment:
+  Enabled: false # false alarms
+
+Naming/FileName:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false # we like our delimiters short and obvious
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false # for points the names x,y are perfectly reasonable
+
+Lint/LiteralAsCondition:
+  Enabled: false # we use while true
+
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Performance/FixedSize:
+  Enabled: false
+
+
+Security/Open:
+  Enabled: false

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Changelog
 
-## [Unreleased] 
-### [0.4.2] - 2019-04-21
+## [0.5.0]
+### Added
+    - Adding support for the jekyll-figure package.
+    - Adding tkiz support, for HTML and PDF.
+    - Moved to chache files inside project tree instead of tmp files.
+
+    
+## [0.4.2] - 2019-04-21
+### Added 
     - Template search routine
     - apa6 template
     - some new config variables (see readme)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-latex-pdf (0.4.2)
+    jekyll-latex-pdf (0.5.0)
       jekyll (~> 3.8.5)
       kramdown (~> 1.17)
 

data/README.md

@@ -36,6 +36,17 @@ Or install it yourself as:
 To make it work with jekyll, you need to add `- jekyll-latex-pdf` to the plugins
 section in your `_config.yml` file of your jekyll site.
 
+You need to have Latex installed on your system.  Default is to use `lualatex`
+and `biber` which depends on your system how to install.  Look for texlive and
+biblatex to see how it works.
+
+If you want to use the `tikz` environment you additionally need to install
+`pdf2svg` and `graphicsmagick`.
+
+You may want to add `.latex-cache` and maybe `.tikz-cache` to your
+`.gitignore`.  This is where we store the latex projects for faster recompiling
+if needed.
+
 ## Usage
 
 Simply add `pdf: true` somewhere in your yaml header of the post.
@@ -66,21 +77,17 @@ pdf:
 All this variables can also be adjusted in the yaml header of your post.
 
 Variables to customize are:
-  - *pdf_engine*: Defaults to `lualatex` and can be changed to pdflatex, xelatex,
-  ...
-  - *bib_engine*: Defaults to `biber` and is only used if the
-    (jekyll-scholar)[https://github.com/inukshuk/jekyll-scholar] is present and
-    enabled in your `_config.yml` file.  biber is part of biblatex, which is
-    used by default.  If you use bibtex, change this to 'bibtex' instead.
-  - *template*: defaults to `jekyll-latex-pdf` which is a upgraded template from
-    kramdown, but to use title author and date and creates the title.  There is
-    also `apa6` present which can be used.  See section *apa6* below. If you
-    want to use, and this is why this gem was made, just start with one of this
-    templates from the git repository and save it inside the `template_path`
-    (which defaults to '_latex') folder in your project with the `.latex`
-    extension, and set the template in your `_config.yml`.
-  - *template_path*: defaults to `_latex` and is the path where your custom
-    templates can be stored.  It is not used if you use the shipped templates only.
+
+| Variable        | Description                                                         |
+|-----------------+---------------------------------------------------------------------|
+| `pdf_engine`    | Defaults to `lualatex` and can be changed to pdflatex, xelatex, ... |
+| `bib_engine`    | Defaults to `biber` and is used when `jekyll-scholar` is present.   |
+| `template`      | Defaults to `jekyll-latex-pdf`                                      |
+| `template_path` | Is where we look for your own templates. Defaults to `_latex`.      |
+| `date_as_note`  | Is `false` by default.  See apa6                                    |
+| `tikz_path`     | Defaults to `assets/tikz_svg`.  See tikz section.                   |
+|-----------------+---------------------------------------------------------------------|
+
 
 Just set up a ticket on
 (issues)[https://gitlab.com/grauschnabel/jekyll-latex-pdf/issues] to add feature
@@ -90,8 +97,9 @@ requests you need.
 
 The default template is a good way to start.  Copy it to your `_latex` folder,
 and adjust it.  Change the name and set the `template` in your config or the
-yaml header of your post.  Your template in _latex will be prefered to the one
-shiped with this gem if it has the same name.
+yaml header of your post.  Your template in `_latex` will be prefered to the one
+shiped with this gem if it has the same name.  Files should have the `.latex`
+extension.  
 
 ### jekyll-latex-pdf
 
@@ -122,8 +130,19 @@ class)[http://mirrors.ctan.org/macros/latex/contrib/apa6/apa6.pdf].
   instead of the date.
 - *authornote*
 - *keywords*
+- *journal*: Original uscase is the journal name.  You can use your website here
+  if you want.
+- *volume*
+- *ccoppy*
+- *copnum*
+
+apa6 does not render the date by default. You can render the date in the note
+field.  Let jekyll-latex-pdf do that for you by setting `date_as_note` to `true`
+in the yaml header of your post or the `_config.yml`s pdf section for all.
 
-## jekyll-scholar integration
+## Integration of other jekyll plugins:
+
+### jekyll-scholar
 
 Check the (jekyll-scholar
 documentation)[https://github.com/inukshuk/jekyll-scholar] to figure out how
@@ -134,6 +153,51 @@ Basically this ignores most of the jekyll-scholar configuration which is just
 for the webpages it creates.  You need to define your citation styles and so on
 in a customized template.
 
+### jekyll-figure
+
+Use this to create figure environments inside html.  With jekyll-latex-pdf you
+get also the figure environment inside latex files.
+
+## Other extras
+
+### Tikz
+
+tikz is a graphics interface used in latex.  We add support for using tikz also
+for html files, so you can use 
+
+```
+   {% tikz filename %}
+     \tikz code goes here
+   {% endtikz %}
+```
+
+On your page.  This will use latex to render the tikz code to a pdf which will
+be converted to svg and png then.  This svg is included as object.  For latex,
+the tikz code will go directly into the source file and will be rendered during
+the rendering process.
+
+You can adjust the `tikz_path` if you want to store the svg and png files
+somewhere else.  The svg file will be used in your page by default, but if the
+browser cannot render it, the png file will be used.
+
+You need to have `pdf2svg` and `graphicsmagick` installed on your system.
+
+## Different versions for html and latex.
+
+Kramdowns (nomarkdown)[https://kramdown.gettalong.org/syntax.html#extensions]
+extension is great for this.  Simple example:
+
+```
+{::nomarkdown type="latex"}
+This should be written in latex, and will not be put in the html version.
+{:/nomarkdown}
+
+{::nomarkdown type="html"}
+This will only be available in the HTML version of the page.  Use HTML instead
+of markdown here.
+{:/nomarkdown}
+```
+
 ## Todo:
 
 - add cite support in the abstract.