Recommended Tools
=================

On this pages we summarize some tools that work nicely with RecipeMD recipes.

recipemd-extract
----------------------

With `recipemd-extract <https://github.com/AberDerBart/recipemd-extract>`_, you can easily download recipes from `large number of popular websites <https://github.com/AberDerBart/recipemd-extract#supported-websites>`_ as RecipeMD.

After installation you can download into the current folder via: 

.. code-block:: shell

    recipmd-extract '<url-of-recipe>'

recipemd-validator
----------------------------------

`recipemd-validator <https://github.com/gindex/recipemd-validator>`_ is a `git hook <https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks>`_ that validates recipes and works out-of-the-box with `pre-commit <https://pre-commit.com/>`_.

To configure add to your :code:`.pre-commit-config.yaml`:

.. code-block:: yaml

    repos:
    - repo: git://github.com/gindex/recipemd-validator
      rev: v0.0.1
      hooks:
        - id: validate-recipemd

Pandoc
------

`Pandoc <https://pandoc.org>`_ is a tool that can be used to convert files between difference markup formats, for example from Markdown to lots of other formats.

Convert a recipe to pdf:

.. code-block:: shell

    recipemd <path/to/recipe.md> | pandoc --pdf-engine=xelatex  -V geometry:margin=2cm -V geometry:a4paper -o <path/to/recipe.pdf>

Convert a folder of recipes to pdfs:

.. code-block:: shell

    ls *.md | xargs -P10 -I{} bash -c 'pandoc --pdf-engine=xelatex  -V geometry:margin=2cm -V geometry:a4paper {} -o $(basename {} md)pdf'

Note that you can specify the `latex template <https://pandoc.org/MANUAL.html#templates>`_ used by pandoc to adopt the output to your taste.

GitLab Markdown Viewer
----------------------

`GitLab Markdown Viewer <https://addons.mozilla.org/en-US/firefox/addon/gitlab-markdown-viewer/>`_ is an add-on for Firefox that allows it to render Markdown recipe. This allows you to use Firefox to navigate your recipe collection.

Other Tools
-----------

If you use any other tools with RecipeMD recipes, we'd like to include them here. Please `send a pull request <https://github.com/tstehr/recipemd/edit/master/docs/recommended_tools.rst>`_ or `open an issue <https://github.com/tstehr/recipemd/issues>`_ to add to this page.