marked-conductor 1.0.15 → 1.0.17

data/src/_README.md

@@ -3,7 +3,7 @@
 
 # Marked Conductor
 
-A "train conductor" for [Marked 2](https://marked2app.com). Conductor can be set up as a Custom Preprocessor or Custom Processor for Marked, and can run different commands and scripts based on conditions in a YAML configuration file, allowing you to have multiple processors that run based on predicates.
+A "train conductor" for [Marked 2](https://marked2app.com) (Mac only). Conductor can be set up as a Custom Preprocessor or Custom Processor for Marked, and can run different commands and scripts based on conditions in a YAML configuration file, allowing you to have multiple processors that run based on predicates.
 
 ## Installation
 
@@ -124,12 +124,16 @@ Conditions can be combined with AND or OR (must be uppercase) and simple parenth
 
 The action can be `script`, `command`, or `filter`. 
 
+#### Scripts
+
 **Scripts** are located in `~/.config/conductor/scripts/` and should be executable files that take input on STDIN (unless `$file` is specified in the `script` definition). If a script is defined starting with `~` or `/`, that will be interpreted as a full path to an alternate location.
 
 > Example:
 > 
 >    script: github_pre
 
+#### Commands
+
 **Commands** are interpreted as shell commands. If a command exists in the `$PATH`, a full path will automatically be determined, so a command can be as simple as just `pandoc`. Add any arguments needed after the command.
 
 > Example:
@@ -139,7 +143,10 @@ The action can be `script`, `command`, or `filter`.
 
 > Using `$file` as an argument to a script or command will bypass processing of STDIN input, and instead use the value of $MARKED_PATH to read the contents of the specified file.
 
+#### Filters
+
 **Filters** are simple actions that can be run on the content without having to write a separate script for it. Available filters are:
+
 | filter | description |
 | :----  | :---------- |
 | `setMeta(key, value)` | adds or updates a meta key, aware of YAML and MMD |
@@ -154,10 +161,18 @@ The action can be `script`, `command`, or `filter`.
 | `prepend/appendFile(path)` | insert a file as Markdown at beginning or end of content |
 | `prepend/appendRaw(path)` | insert a file as raw HTML at beginning or end of content |
 | `prepend/appendCode(path)` | insert a file as a code block at beginning or end of content |
+| `insertCSS(path)` | insert custom CSS into document |
+| `autoLink()` | Turn bare URLs into \<self-linked\> urls |
+
+For `replace` and `replaceAll`: If *search* is surrounded with forward slashes followed by optional flags (*i* for case-insensitive, *m* to make dot match newlines), e.g. `/contribut(ing)?/i`, it will be interpreted as a regular expression. The *replace* value can include numeric capture groups, e.g. `Follow$2`.
 
 For `insertScript`, if path is just a filename it will look for a match in `~/.config/conductor/javascript` or `~/.config/conductor/scripts` and turn that into an absolute path if the file is found.
 
-For `replace` and `replaceAll`: If *search* is surrounded with forward slashes followed by optional flags (*i* for case-insensitive, *m* to make dot match newlines), e.g. `/contribut(ing)?/i`, it will be interpreted as a regular expression. The *replace* value can include numeric capture groups, e.g. `Follow$2`.
+For `insertCSS`, if path is just a filename (with or without .css extension), the file will be searched for in `~/.config/conductor/css` or `~/.config/conductor/files` and injected. CSS will be compressed using the YUI algorithm and inserted at the top of the document, but after any existing metadata.
+
+For all of the prepend/append file filters, you can store files in `~/.config/conductor/files` and reference them with just a filename. Otherwise a full path will be assumed.
+
+For `autoLink`, any URL that's not contained in parenthesis or following a `[]: url` pattern will be autolinked (surrounded by angle brackets). URLs must contain `//` to be recognized, but any protocol will work, e.g. `x-marked://refresh`.
 
 > Example:
 > 
@@ -180,7 +195,7 @@ A script run by Conductor already knows it has the right type of file with the e
 - Config file must be valid YAML. Any value containing colons, brackets, or other special characters should be quoted, e.g. (`condition: "text contains my:text"`)
 - You can see what condition matched in Marked by opening **Help->Show Custom Processor Log** and checking the STDERR output.
 - To run [a custom processor for Bear](https://brettterpstra.com/2023/10/08/marked-and-bear/), use the condition `"text contains <!-- source: bear.app -->"`. You might consider running a commonmark CLI with Bear to support more of its syntax.
-- To run a custom processor for Obsidian, use the condition `tree contains .obsidian`
+- To run a [custom processor for Obsidian](https://brettterpstra.com/2024/05/16/marked-2-and-obsidian/), use the condition `tree contains .obsidian`
 
 ## Testing
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marked-conductor
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.17
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-25 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -218,6 +218,8 @@ files:
 - html/README_rdoc.html
 - html/String.html
 - html/TrueClass.html
+- html/YuiCompressor.html
+- html/YuiCompressor/Yui.html
 - html/created.rid
 - html/css/fonts.css
 - html/css/rdoc.css
@@ -275,6 +277,7 @@ files:
 - lib/conductor/script.rb
 - lib/conductor/string.rb
 - lib/conductor/version.rb
+- lib/conductor/yui-compressor.rb
 - marked-conductor.gemspec
 - src/_README.md
 - test.md