pretty_doc 1.0.0

data/pretty_doc.gemspec

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_doc/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'pretty_doc'
+  s.version       = PrettyDoc::VERSION
+  s.authors       = ['lyfeyaj']
+  s.email         = ['lyfeyaj@gmail.com']
+  s.description   = 'Pretty Doc is quick and convenient markdown to html converter with beautiful templates, aiming to provide a simple tool to generate beautiful docs for common use.'
+  s.summary       = 'Pretty Doc is quick and convenient markdown to html converter with beautiful templates, aiming to provide a simple tool to generate beautiful docs for common use.'
+  s.homepage      = 'https://github.com/lyfeyaj/pretty_doc'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'nokogiri', '~> 1.6.6'
+  s.add_dependency 'kramdown', '~> 1.8.0'
+  s.add_dependency 'pygments.rb', '~> 0.6.3'
+  s.add_dependency 'compass', '~> 1.0.3'
+  s.add_dependency 'bootstrap-sass', '~> 3.3.5'
+
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'rake', ['>= 0']
+  s.add_development_dependency 'rspec', ['>= 3.0.0']
+  s.add_development_dependency 'rspec-its', ['>= 1.0.0']
+  s.add_development_dependency 'pry', ['>= 0']
+end

data/templates/bootstrap/init.rb

@@ -0,0 +1,10 @@
+require 'bootstrap-sass'
+
+# Bootstrap Template
+class BootstrapTemplate < PrettyDoc::Template
+  def initialize
+    self.dir = Pathname.new(__FILE__).dirname
+  end
+end
+
+PrettyDoc::Template.register('bootstrap', BootstrapTemplate.new)

data/templates/bootstrap/style.scss

@@ -0,0 +1,252 @@
+@import "compass";
+
+$baseFontSize: 15px;
+$baseLineHeight: $baseFontSize * 1.5;
+
+@import "bootstrap";
+
+html, body {
+  margin: 0;
+  padding: 0;
+}
+
+@media print {
+  @page {
+    margin: 1cm;
+  }
+
+  body {
+        width: 19cm;
+    min-width: 19cm;
+    max-width: 19cm;
+  }
+
+  img, .thumbnail {
+    page-break-inside: avoid;
+  }
+}
+
+@media screen {
+  html, body {
+    background: gray;
+  }
+
+  body {
+    margin: 1cm auto;
+    width: 21cm;
+    min-height: 29.7cm;
+    @include box-sizing(border-box);
+    padding: 1cm;
+    background: white;
+    box-shadow: 0px 0px 0.5cm black;
+  }
+}
+
+body {
+}
+
+
+// h1 { font-size: $baseFontSize * 2.5; }
+// h2 { font-size: $baseFontSize * 2.0; }
+// h3 { font-size: $baseFontSize * 1.5; }
+// h4 { font-size: $baseFontSize * 1.1; }
+// h5 { font-size: $baseFontSize * 0.9; }
+// h6 { font-size: $baseFontSize * 0.8; }
+
+// h4, h5, h6 {
+//  line-height: $baseLineHeight;
+// }
+
+article {
+  h1, h2, h3, h4, h5, h6 {
+    margin: 1em 0 0.5em 0;
+  }
+
+  h1 {
+    margin-top: 0;
+  }
+
+  p {
+    margin-bottom: 0.75em;
+
+    img {
+      width: 100%;
+    }
+
+    code {
+      white-space: nowrap;
+    }
+  }
+
+  dt {
+    margin-top: 1em;
+    margin-bottom: 0.3em;
+  }
+
+  ul, ol {
+    li {
+      margin: 0.3em 0;
+    }
+  }
+
+  .thumbnail {
+
+    figcaption {
+      margin-top: 0.2em;
+      text-align: center;
+      font-style: italic;
+    }
+  }
+
+  // figure {
+  //  width: 100%;
+  //  margin: 0;
+  //  margin-bottom: 0.75em;
+  //  padding: 0;
+
+  //  img {
+  //    width: 100%;
+  //    @include box-sizing(border-box);
+  //    border: 1px solid #999;
+  //    padding: 0.5em;
+  //  }
+  // }
+
+  table {
+    @extend .table;
+    @extend .table-bordered;
+
+    th {
+      white-space: nowrap;
+    }
+  }
+
+  pre {
+    font-size: $baseFontSize * 0.8;
+    white-space: pre;
+    word-break: normal;
+    word-wrap: normal;
+    overflow-x: auto;
+    line-height: 1.5;
+
+    code {
+      font-size: inherit;
+      white-space: pre;
+      @include experimental(tab-size, 4);
+    }
+  }
+}
+
+.highlight {
+  padding: 8px;
+  background-color: #f7f7f9;
+  border: 1px solid #e1e1e8;
+  margin-bottom: 20px;
+
+  @include box-shadow(inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0);
+  @include border-radius(4px);
+
+  table {
+    margin: 0;
+    table-layout: fixed;
+  }
+
+  table, td, th {
+    border: none;
+    padding: 0;
+  }
+
+  .lines {
+    width: 33px;
+    pre {
+      color: #bebec5;
+    }
+
+    .line-number:after {
+      content: ".";
+    }
+  }
+
+  .code {
+    padding-left: 8px;
+  }
+
+  pre {
+    @include border-radius(0px);
+    border: none;
+    margin: 0;
+    padding: 0;
+    background: transparent;
+  }
+
+  .c  { color: #999988; font-style: italic } /* Comment */
+  .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+  .k  { color: #000000; font-weight: bold } /* Keyword */
+  .o  { color: #000000; font-weight: bold } /* Operator */
+  .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+  .cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */
+  .c1 { color: #999988; font-style: italic } /* Comment.Single */
+  .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+  .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+  .ge { color: #000000; font-style: italic } /* Generic.Emph */
+  .gr { color: #aa0000 } /* Generic.Error */
+  .gh { color: #999999 } /* Generic.Heading */
+  .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+  .go { color: #888888 } /* Generic.Output */
+  .gp { color: #555555 } /* Generic.Prompt */
+  .gs { font-weight: bold } /* Generic.Strong */
+  .gu { color: #aaaaaa } /* Generic.Subheading */
+  .gt { color: #aa0000 } /* Generic.Traceback */
+  .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+  .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+  .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */
+  .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+  .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+  .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+  .m  { color: #009999 } /* Literal.Number */
+  .s  { color: #d01040 } /* Literal.String */
+  .na { color: #008080 } /* Name.Attribute */
+  .nb { color: #0086B3 } /* Name.Builtin */
+  .nc { color: #445588; font-weight: bold } /* Name.Class */
+  .no { color: #008080 } /* Name.Constant */
+  .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */
+  .ni { color: #800080 } /* Name.Entity */
+  .ne { color: #990000; font-weight: bold } /* Name.Exception */
+  .nf { color: #990000; font-weight: bold } /* Name.Function */
+  .nl { color: #990000; font-weight: bold } /* Name.Label */
+  .nn { color: #555555 } /* Name.Namespace */
+  .nt { color: #000080 } /* Name.Tag */
+  .nv { color: #008080 } /* Name.Variable */
+  .ow { color: #000000; font-weight: bold } /* Operator.Word */
+  .w  { color: #bbbbbb } /* Text.Whitespace */
+  .mf { color: #009999 } /* Literal.Number.Float */
+  .mh { color: #009999 } /* Literal.Number.Hex */
+  .mi { color: #009999 } /* Literal.Number.Integer */
+  .mo { color: #009999 } /* Literal.Number.Oct */
+  .sb { color: #d01040 } /* Literal.String.Backtick */
+  .sc { color: #d01040 } /* Literal.String.Char */
+  .sd { color: #d01040 } /* Literal.String.Doc */
+  .s2 { color: #d01040 } /* Literal.String.Double */
+  .se { color: #d01040 } /* Literal.String.Escape */
+  .sh { color: #d01040 } /* Literal.String.Heredoc */
+  .si { color: #d01040 } /* Literal.String.Interpol */
+  .sx { color: #d01040 } /* Literal.String.Other */
+  .sr { color: #009926 } /* Literal.String.Regex */
+  .s1 { color: #d01040 } /* Literal.String.Single */
+  .ss { color: #990073 } /* Literal.String.Symbol */
+  .bp { color: #999999 } /* Name.Builtin.Pseudo */
+  .vc { color: #008080 } /* Name.Variable.Class */
+  .vg { color: #008080 } /* Name.Variable.Global */
+  .vi { color: #008080 } /* Name.Variable.Instance */
+  .il { color: #009999 } /* Literal.Number.Integer.Long */
+}
+
+.no-lines {
+  @include box-shadow(none);
+}
+
+@media print {
+  .highlight pre {
+    overflow-x: hidden;
+  }
+}

data/templates/bootstrap/template.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title><%= @title %></title>
+    <link rel="stylesheet" type="text/css" href="style.css" />
+  </head>
+  <body>
+    <article id='container'>
+      <%= @content %>
+    </article>
+  </body>
+</html>

data/templates/default/_mixin.scss

@@ -0,0 +1,63 @@
+$baseSize: 12pt;
+$baseLineHeight: $baseSize * 1.4;
+
+$normalText:              #333;
+$normalBackground:        #f5f5f5;
+$normalBorder:            darken(adjust-hue($normalBackground, -10), 7%) !default;
+
+$warningText:             #c09853 !default;
+$warningBackground:       #fcf8e3 !default;
+$warningBorder:           darken(adjust-hue($warningBackground, -10), 3%) !default;
+
+$errorText:               #b94a48 !default;
+$errorBackground:         #f2dede !default;
+$errorBorder:             darken(adjust-hue($errorBackground, -10), 3%) !default;
+
+$successText:             #468847 !default;
+$successBackground:       #dff0d8 !default;
+$successBorder:           darken(adjust-hue($successBackground, -10), 5%) !default;
+
+$infoText:                #3a87ad !default;
+$infoBackground:          #d9edf7 !default;
+$infoBorder:              darken(adjust-hue($infoBackground, -10), 7%) !default;
+
+.box {
+  padding: ($baseSize * 0.5) ($baseSize * 1);
+  border-radius: 0.3em;
+  background-color: $normalBackground;
+  border: 1px solid $normalBorder;
+}
+
+.box-warning {
+  @extend .box;
+  background-color: $warningBackground;
+  border-color: $warningBorder;
+  color: $warningText;
+}
+
+.box-success {
+  @extend .box;
+  background-color: $successBackground;
+  border-color: $successBorder;
+  color: $successText;
+}
+
+.box-info {
+  @extend .box;
+  background-color: $infoBackground;
+  border-color: $infoBorder;
+  color: $infoText;
+}
+
+.box-normal {
+  @extend .box;
+  background-color: $normalBackground;
+  border-color: 1px solid $normalBorder;
+}
+
+.box-error, .box-danger {
+  @extend .box;
+  background-color: $errorBackground;
+  border-color: $errorBorder;
+  color: $errorText;
+}