mint 0.7.4 → 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49d66d53b189d1897ab9938358279f7dc0c4ede1d44926eba5f1b9b6f7d8344b
+  data.tar.gz: '08b1882ec1972dbedd02c87e0e6a4cf1f61ca0a631c7f56bca20b4dfeb1ea36b'
+SHA512:
+  metadata.gz: 3acb8ce3fc1856014e0efe3aa94d3720faeb8f677e2f9e3a46c541ecc8bd62f65a187558421ac10acc0599f813a8d161bed142bf44c75b51e6bc8f140351cc7f
+  data.tar.gz: 3851e818c5bad026bfde0302c8fe3184dfe4d79e93ca87479e85590015bb3fd082926fe88f7397144b8fbbb4163ae9e602bbb510bf23da009d20943b334896c2

data/Gemfile

@@ -1,18 +1,27 @@
-source :rubygems
+source "https://rubygems.org"
 
-gem "tilt"
-gem "rdiscount"
-gem "haml"
-gem "sass"
-gem "less"
-gem "activesupport"
+# General
+gem "rubyzip", "~> 3.0", ">= 3.0.1"
+gem "hashie", "~> 5.0"
+gem "nokogiri", "1.15.5"
 
-gem "rubyzip"
-gem "hashie"
-gem "nokogiri"
+# Templates
+gem "tilt", "~> 2.6", ">= 2.6.1"
+gem "redcarpet", "~> 3.6", ">= 3.6.1"
+gem "erubis", "~> 2.7"
+gem "haml", "~> 6.3"
+gem "sass-embedded", '~> 1.90'
 
-gem "rspec"
-gem "cucumber"
-gem "aruba"
+# Helpers
+gem "activesupport", "~> 8.0", ">= 8.0.2.1"
 
-gem "debugger"
+group :development do
+  gem "pry"
+end
+
+# Testing dependencies
+group :test do
+  gem "rspec", "~> 3.13", ">= 3.13.1"
+  gem "rspec-its", "~> 1.3"
+  gem "colorize", "~> 1.1"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 David Jacobs
+
+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 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

@@ -1,111 +1,100 @@
-What is Mint?
--------------
+# Mint
 
-Mint transforms your plain text documents into beautiful documents. It makes that process as simple (but customizable) as possible.
+Transform your plain text documents into beautiful HTML documents with customizable styling and templates.
 
-Why would you want to keep all of your documents as plain text?
+## Installation
 
-- To focus on words and structure when you write
-- To be able to apply one style to an entire set of documents with one command
-- To keep your documents under version control
-- To make your documents available for scripting--for example, text analysis
+```bash
+gem install mint
+```
 
-What does Mint create from these source files? Beautiful, styled HTML ready to print, e-mail, and present.
+## Quick Start
 
-In a few words: *Mint processes words so you don't have to.*
+Transform a Markdown document into styled HTML:
 
-The mint command
-----------------
+```bash
+mint publish Document.md
+```
 
-If you have a plain text document formatted in Markdown or Textile or almost any other templating language, you're ready to go.
+This creates `Document.html` in your current directory with beautiful default styling.
 
-The easiest Mint command doesn't require configuration. It transforms a document into HTML and links it to the default stylesheet, which I've designed for you.
+## Usage
 
-Simply type:
+### Basic Commands
 
-    mint publish Minimalism.md
+```bash
+# Publish a single document
+mint publish Document.md
 
-And voilà, Minimalism.html will show up next to Minimalism.md.
+# Publish with a template
+mint publish Document.md --template nord
 
-Opening Minimalism.html with your favorite web browser--[Firefox is best for typography][Firefox typography], but Webkit-based browsers (Chrome, Safari) work, too--will show what looks like a word-processed document, complete with big bold headers, italic emphasis, automatically indented and numbered lists, and bullets. If you're in a modern browser, you'll even see ligatures and proper kerning. The page will be on a white canvas that looks like a page, even though you are in a browser.
+# Publish to a specific directory
+mint publish Document.md --destination public
 
-Sending that page to a printer is as easy as clicking "Print" from your browser. What comes out of your printer will have a 12 pt base font, normal margins, and a not-too-cramped baseline. (Ah the wonder of print stylesheets.)
+# Publish multiple files
+mint publish *.md --destination final-drafts
 
-You can throw as many files as you'd like in. Any commandline argument *not* preceded by an option (e.g., `--template`) or in the `mint` command vocabulary (more on that in a minute) will be interpreted as a file name:
+# Publish a digital garden, with linked navigation
+mint publish content/**/*.md --template garden --destination public
+```
 
-    mint publish Minimalism.md Proposal.md Protocol.md
+### Common Options
 
-This command can be tweaked with options and arguments to be more flexible:
+| Flag | Description |
+|------|-------------|
+| `-t, --template TEMPLATE` | Use a built-in template (combines layout + style) |
+| `-l, --layout LAYOUT` | Specify only the layout |
+| `-s, --style STYLE` | Specify only the style |
+| `-d, --destination DIR` | Output directory |
+| `-o, --output-file FORMAT` | Custom output filename format |
+| `--style-mode MODE` | How styles are included (inline, external, original) |
+| `--style-destination PATH` | Create external stylesheet and link it (sets mode to external) |
+| `-r, --recursive` | Find all Markdown files in any directories specified |
 
-    mint publish Minimalism.md --template resume  # specifies a style template
-    mint publish Minimalism.md --destination final --style-destination=styles
+### Style modes
 
-For a listing of mint options, take [a look at the API][API].
+Mint offers three ways to include styles in your HTML output:
 
-A basic Mint document
----------------------
+- **`inline`** (default) – CSS is embedded directly in the HTML document as `<style>` tags
+- **`external`** – CSS is compiled and saved as separate files, linked with `<link>` tags
+- **`original`** – Links directly to original CSS template files without processing (for live editing)
 
-Mint is loaded with smart defaults, so if you don't want to configure something--say, the basic HTML skeleton of your document or the output directory--you don't have to. You'll probably be surprised at how easy it is to use out of the box, and how configurable it is.
+The `original` mode is particularly useful for template development, as it allows you to edit CSS files and see changes immediately without republishing. Only `.css` files are supported in this mode, and `@import` statements in CSS files will be included as additional `<link>` tags.
 
-    document = Document.new "Minimalism.md"
-    document.publish!
+### Built-in templates
 
-If you want to customize your document, though--and that's why I built this library--Mint makes that easy.
+- `default` – Clean, minimal styling
+- `nord` – Clean, uses Nord color scheme
+- `nord-dark` – Dark version of Nord
+- `garden` – For digital gardens; includes navigation
 
-To understand Mint's flexibility, you'll want to [take a look at the API][API].
+## Documentation
 
-[Firefox typography]: http://opentype.info/blog/2008/06/14/kerning-and-opentype-features-in-firefox-3/ "Firefox 3 supports kerning and automatic ligatures"
+- **Complete usage guide:** [TUTORIAL.md](doc/TUTORIAL.md)
+- **Man page:** `man mint` (after installation)
+- **API documentation:** [RubyDoc](http://www.rubydoc.info/github/davejacobs/mint)
 
-Templates
----------
+## Why Mint?
 
-Templates can be written in any format accepted by the Tilt template interface library. (See [the Tilt TEMPLATES file][Tilt templates] for more information.)
+- **Focus on writing** – Keep documents as plain text
+- **Version control friendly** – Text files work great with Git
+- **Scriptable** – Automate document processing
+- **Beautiful output** – Professional-looking HTML ready for print or web
+- **Highly customizable** – Create your own templates and styles
 
-In a template layouts, Ruby calls are sparse but necessary.
+## Templates and customization
 
-If you're designing a layout, you need to indicate where Mint should place your content. For that simple reason, raw HTML files cannot be layouts. Instead, if you want to use HTML templates, you should use the ERB format. These files are essentially HTML with the possibility for Ruby calls. You can even use the .html extension for your files. Just code the dynamic portion using ERB syntax.
+Mint supports layouts written in HAML or ERB and stylesheets can be written in CSS, SCSS, or SASS.
 
-Inside your template, use the `content` method to place your source's content.
+## Contributing
 
-You will want to point to your document's stylesheet (via a relative URL) from within your layout, usually in the `<head/>` element. Use the `stylesheet` method.
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run the tests: `rspec`
+5. Submit a pull request
 
-So if you're writing your layout using Haml, the template might look like this:
-
-    !!!
-    %html
-      %head
-        %link(rel="stylesheet" href=stylesheet)
-
-      %body
-        #container= content
-
-You can build stylesheets using [CSS][], [SASS/SCSS][] or [Less][]. They will always be compiled for you.
-
-Mint comes preloaded with several styles and layouts.
-
-1. Default
-2. Zen
-3. Resume\*
-4. Protocol
-5. Protocol Flow\* - requires Javascript and jQuery
-
-> Note: Starred entries are not yet implemented. If you have a killer
-> template you think should be included, send it my way. I'll check
-> it out and see if it should be part of the standard template library.
-> (Of course, you'll get all the credit.)
-
-I've included a base stylesheet that is useful for setting sensible typographic defaults.
-
-Plugins: A work in progress
----------------------------
-
-I've designed the beginnings of a plugin system. With this system, you can implement a callback or two and have full control over document creation and sharing. I'll get documentation going soon. For now, look to lib/mint/plugins/epub.rb and bin/mint-epub for an example of how to build one. It's not complete and I'm open to API suggestions. 
-
-This is going to be useful for things like creating actual office documents or e-books or even bound novels. I'm actually thinking that half the power of this library is its plugin system.
-
-[API]: http://github.com/davejacobs/mint/tree/master/doc/API.md
-[Tilt templates]: http://github.com/rtomayko/tilt/blob/master/TEMPLATES.md "A listing of all templates supported by Tilt."
-[CSS]: http://en.wikipedia.org/wiki/Cascading_Style_Sheets
-[SASS/SCSS]: http://sass-lang.com/
-[Less]: http://lesscss.org/
+## License
 
+MIT License. See [LICENSE](LICENSE) for details.

data/bin/mint

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
-# A script for harnessing Mint at the commandline
-# Usage: mint [command] [options] [files]
+
+# Add /lib to path to override any local installations of Mint
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require "mint"
 require "shellwords"
@@ -8,7 +9,8 @@ require "shellwords"
 argv, commandline_options, help = 
   Mint::CommandLine.parse(ARGV).values_at(:argv, :options, :help)
 
-case argv.shift.downcase.to_sym
+original_command = argv.first
+case (argv.shift || "help").downcase.to_sym
 when :publish
   # Aruba chokes here, so we use this hack to convince Mint we're
   # not in a pipeline
@@ -21,18 +23,46 @@ when :publish
       end
     end
   Mint::CommandLine.publish!(files, commandline_options)
+when :preview
+  # Preview mode uses live CSS links instead of inline styles
+  Mint.rendering_mode = :preview
+  files = 
+    if $stdin.tty? || ENV["MINT_NO_PIPE"]
+      argv
+    else
+      $stdin.each_line.reduce [] do |list, line|
+        list.concat(Shellwords.split(line))
+      end
+    end
+  Mint::CommandLine.publish!(files, commandline_options)
 when :help
   Mint::CommandLine.help(help)
 when :install
-  Mint::CommandLine.install(argv.shift, commandline_options)
+  file = argv.shift
+  name = argv.shift
+  scope = commandline_options[:scope] || :local
+  Mint::CommandLine.install(file, name, scope)
 when :uninstall
-  Mint::CommandLine.uninstall(argv.shift, commandline_options)
+  name = argv.shift
+  scope = commandline_options[:scope] || :local
+  Mint::CommandLine.uninstall(name, scope)
 when :templates
-  Mint::CommandLine.templates(argv.shift, commandline_options)
-when :edit
-  Mint::CommandLine.edit(argv.shift, commandline_options)
+  filter = argv.shift
+  scope = commandline_options[:scope] || :local
+  Mint::CommandLine.templates(filter, scope)
+when :"edit-layout"
+  name = argv.shift
+  scope = commandline_options[:scope] || :local
+  Mint::CommandLine.edit(name, :layout, scope)
+when :"edit-style" 
+  name = argv.shift
+  scope = commandline_options[:scope] || :local
+  Mint::CommandLine.edit(name, :style, scope)
 when :set
-  Mint::CommandLine.set(argv.shift, argv.shift, commandline_options)
+  key = argv.shift
+  value = argv.shift
+  scope = commandline_options[:scope] || :local
+  Mint::CommandLine.set(key, value, scope)
 when :config
   Mint::CommandLine.config
 else
@@ -43,8 +73,15 @@ else
   # document list.
   
   begin
-    system 'mint-#{argv.first} #{argv[1..-1].join " "}'
+    if File.executable? "mint-#{original_command}"
+      system "mint-#{original_command} #{argv[1..-1].join ' '}"
+    else
+      $stderr.puts "Error: Unknown command '#{original_command}'"
+      Mint::CommandLine.help(help)
+      exit 1
+    end
   rescue
     Mint::CommandLine.help(help)
+    exit 1
   end
 end

data/bin/mint-epub

@@ -3,13 +3,10 @@
 # A script for publishing Mint in the ePub format
 # Usage: mint epub [command] [options] [files]
 
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require "mint"
 require "mint/plugins/epub"
 
-# NOTE: This is not how I want this plugin to be called.
-# However, I do want a first iteration of the plugin
-# system on master, so we'll go with this for now.
-
 def usage
   abort "mint epub publish file"
 end

data/config/templates/base/style.css

@@ -0,0 +1,187 @@
+@import '../reset.css';
+
+body {
+  font-family: var(--body-font-family), Georgia, serif;
+}
+
+h1, h2 {
+  line-height: 1.3;
+}
+
+h2, h3, h4, h5, h6 {
+  line-height: var(--screen-line-height);
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: var(--header-font-family);
+  font-weight: normal;
+}
+
+h1 {
+  font-size: calc(var(--screen-font-size) * 1.5);
+  margin-top: var(--screen-unit);
+  margin-bottom: var(--screen-unit);
+}
+
+h2 {
+  font-size: calc(var(--screen-font-size) * 1.2);
+  margin-top: calc(var(--screen-unit) * 3 / 2);
+  margin-bottom: calc(var(--screen-unit) * 1 / 2);
+}
+
+h3 {
+  font-size: calc(var(--screen-font-size) * 1.1);
+  margin-top: calc(var(--screen-unit) * 7 / 4);
+  margin-bottom: calc(var(--screen-unit) * 1 / 4);
+}
+
+h4 {
+  font-size: calc(var(--screen-font-size) * 1.05);
+  margin-top: calc(var(--screen-unit) * 7 / 8);
+  margin-bottom: calc(var(--screen-unit) * 1 / 8);
+}
+
+h5, h6 {
+  font-size: var(--screen-font-size);
+  margin-top: calc(var(--screen-unit) * 7 / 8);
+  margin-bottom: calc(var(--screen-unit) * 1 / 8);
+}
+
+ul {
+  list-style-type: square;
+}
+
+ul ul {
+  list-style-type: circle;
+}
+
+ul, ol {
+  margin: calc(var(--screen-unit) / 4) 0 0 calc(var(--screen-unit) / 2);
+  padding-left: calc(var(--screen-unit) * 1.2);
+}
+
+ul li p, ol li p {
+  text-indent: 0 !important;
+}
+
+ul li + li, ol li + li {
+  margin-top: calc(var(--screen-unit) / 4);
+}
+
+p {
+  margin: calc(var(--screen-unit) / 2) 0;
+}
+
+ul + p, ol + p, blockquote + p, pre + p {
+  text-indent: 0;
+}
+
+a:link, a:visited, a:active {
+  color: var(--link-color);
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+code {
+  font-family: Monaco, Menlo, Mensch, Consolas, Monotype, mono;
+  font-style: normal;
+}
+
+pre {
+  display: block;
+  margin-left: var(--screen-unit);
+  margin-right: calc(var(--screen-unit) * 2);
+  padding: calc(var(--screen-unit) / 3) var(--screen-unit);
+  padding-left: calc(var(--screen-unit) * 3 / 4);
+  white-space: pre;
+}
+
+blockquote {
+  display: block;
+  margin-left: var(--screen-unit);
+  margin-right: calc(var(--screen-unit) * 2);
+  padding: calc(var(--screen-unit) / 3) var(--screen-unit);
+  padding-left: calc(var(--screen-unit) * 3 / 4);
+}
+
+pre p, blockquote p {
+  margin: 0;
+  line-height: 1.35;
+}
+
+img {
+  display: block;
+}
+
+@media screen {
+  body {
+    font-size: var(--screen-font-size);
+    line-height: var(--screen-line-height);
+    background-color: #666;
+    color: var(--text-color);
+  }
+
+  #container {
+    display: block;
+    border: solid 1px #999;
+    width: 780px;
+    padding: 40px 60px;
+    margin: calc(var(--screen-unit) / 2) auto;
+    background-color: #fff;
+    box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    -webkit-box-sizing: border-box;
+  }
+  
+  code {
+    font-size: calc(var(--screen-font-size) * 7 / 8);
+  }
+
+  pre {
+    white-space: pre-wrap;
+    white-space: -moz-pre-wrap;
+    white-space: -o-pre-wrap;
+    word-wrap: break-word;
+  }
+
+  pre code {
+    font-size: calc(var(--screen-font-size) * 3 / 4);
+  }
+}
+
+@media print {
+  @page {
+    margin-left: 1in;
+    margin-right: 1in;
+    margin-top: 1in;
+    margin-bottom: 1in;
+  }
+
+  body {
+    font-size: var(--print-font-size);
+    line-height: var(--print-line-height);
+    width: auto;
+    margin: 0;
+    padding: 0;
+  }
+
+  code {
+    font-size: calc(var(--print-font-size) * 7 / 8);
+  }
+
+  pre code {
+    font-size: calc(var(--print-font-size) * 3 / 4);
+  }
+
+  h1, h2, h3, h4, h5, h6, li, blockquote {
+    page-break-inside: avoid;
+  }
+
+  p {
+    widows: 3;
+    orphans: 3;
+  }
+}

data/config/templates/default/layout.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= stylesheet_tag %>
+    <style type="text/css"><%= inline_styles %></style>
+  </head>
+  <body>
+    <div id="container"><%= content %></div>
+  </body>
+</html>