Readme Rendering

If there is a readme.md (case insensitive) (can be configured) file in the current directory, it will be rendered. GitHub flavored markdown is supported. See Demo Page.

.dbmeta.md file

You can specify a .dbmeta.md file in a directory to render it while also hiding it from the file tree, API and downloads at the same time. A .dbmeta.md file will override a existing readme.md file. See Demo.

info

By default unsafe HTML inside markdown (such as <script>) will be escaped. You can allow any html by enabling the option. However, allowing untrusted HTML can result in XSS attacks.

⚙️ Configuration

Variable	Default	Values	Details
README_RENDER	true	true false	added in v1.1
README_NAME	readme.md;readme.txt;readme.html;readme;read.me;read\ me;liesmich.md;liesmich.txt;liesmich;lies\ mich;index.html;index.htm;index.txt;license	<string>	The case-insensitive file names seperated by a semicolon which should be renderedadded in v3.2
README_FIRST	false	true false	Render the readme above the file tree instead of below it.added in v3.2
ALLOW_RAW_HTML	false	true false	added in v1.1
README_META	true	true false	Renders a .dbmeta.md file if it existsadded in v3.5

How to set configuration options

Set the environment variables when starting the container.
Use docker run...

• ...with -e README_RENDER=true
• ...with --env-file .env and place README_RENDER=true in the file

See installation page for more details.