Skip to main content
Version: v3 (latest✅)

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.

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

VariableDefaultValuesDetails
README_RENDERtruetrue
false
added in v1.1
README_NAMEreadme.md<string>
The case-insensitive file name which should be renderedadded in v3.2
README_FIRSTfalsetrue
false
Render the readme above the file tree instead of below it.added in v3.2
ALLOW_RAW_HTMLfalsetrue
false
added in v1.1
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.