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
Variable | Default | Values | Details |
---|---|---|---|
README_RENDER | true | true false | added in v1.1 |
README_NAME | readme.md | <string> | The case-insensitive file name 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 |
How to set configuration options
Set the environment variables when starting the container.
Use
Use
docker run
...- ...with
-e README_RENDER=true
- ...with
--env-file .env
and placeREADME_RENDER=true
in the file