read-go

read-go
-------

.. image:: https://pix.watch/62tBpX/PURcI2.png
    :target: https://www.buymeacoffee.com/Artemis

Small web markdown-renderer.

Generated PDFs
==============

Every generated PDF is stored on file system, which means that it may become heavy.

I'd recommend setting up a cron job which would run about once a day/week, and remove every file older than 7 days.

The following command does the job: ``find /path/to/files* -mtime +5 -exec rm {} \;``.

Configuration
=============

The configuration file is in YAML format and must be called ``read.yml``.

Configuration paths
###################

read will try to load the configuration file from, in order, those following paths.

- ``/etc``
- ``/etc/read``
- ``/opt``
- ``/opt/read``
- ``$HOME``
- ``$HOME/.read``
- ``.`` (``$PWD``)

Configuration keys
##################

The following keys are open for configuration.

- ``HTTPHost``, default to ``127.0.0.1:8080``: the address on which read-go must listen.
- ``DataPath``, default to ``./data``: the path to the folder which contains your markdown documents.
- ``PDFCache``, default to ``/tmp``: the path to the folder which will contain every generated PDF
- ``PDFFilePrefix``, default to ``read-``: The prefix which will be used to name temporary PDF files, to avoid tmp folder file mismatch