RegExRX2MD

Convert RegExRX file to Markdown

Description

Converts native RegExRX documents to Markdown files containing code snippets that work with Snibbets or any Markdown viewer.

Installation

$ gem install regexrx2md

If you run into errors, try:

$ gem install --user-install regexrx2md

Usage

Run regexrx2md in a directory containing .regexrx files and all matching files will be processed to Markdown files in a markdown subdirectory.

If the argument is a directory, all .regexrx files in the directory will be processed and output to the --output-dir destination (which defaults to markdown). If the argument is a single .regexrx file, only that file will be processed. Markdown filenames will be based on the title of the RegExRX file, either from the built-in name field, or from the filename if it's untitled.

Options:

Usage: bin/regexrx2md [OPTIONS] [SOURCE FILE/DIR]

Converts RegExRx files to Markdown, optionally with template.
    If source argument is empty, process all .regexrx files in current directory.

Options:
    -o, --output-dir=DIRECTORY       Output folder
                                     Defaults to "./markdown"
    -p, --prefix=PREFIX              Prefix added before output filenames
                                     Space automatically added after prefix
    -t, --template=TEMPLATE          Use alternate ERB template
    -h, --help                       Display this screen
    -x, --example                    Output the default ERB template to STDOUT

You can specify a prefix for filenames using the --prefix option. For example, using --prefix="RX - " would cause URL detector.regexrx to create RX - URL detector.md as the Markdown output file.

The default template outputs notes as block quotes and snippets as Ruby fenced code blocks. You can adjust this by using a custom ERB template. Just output the default template using --example, save it to a new file and edit as needed, then pass the new file using --template=NEW_FILE.erb. The template file must be named with an erb extension.

Source code

The source code is hosted on GitHub. Clone the project with

$ git clone git@github.com:ttscoff/regexrx2md.git

Development and Testing

Quickstart

$ git clone https://github.com/ttscoff/regexrx2md.git
$ cd regexrx2md
$ bundle install

Run the command below

$ bundle exec bin/regexrx2md

Open an interactive ruby console with

$ bundle exec rake console

Primary development tasks are defined as rake tasks in the Rakefile and available via rake. View them with

$ bundle exec rake -T

Requirements

You will need Ruby with Bundler.

Be sure that all commands run under the correct Ruby version, e.g., if using rbenv, install the correct version with

$ rbenv install

Install the development dependencies with

$ bundle install

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

1. Fork it (https://github.com/ttscoff/regexrx2md/fork).
2. Create your feature branch (git checkout -b my-new-feature).
3. Make changes.
4. Commit your changes (git commit -am 'Add some feature').
5. Push to the branch (git push origin my-new-feature).
6. Create a new Pull Request.

License

This Ruby gem is licensed under the MIT license.

Warranty

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.