feat: support multiple readmes

Author: adrianschubek

Dockerfile

@@ -71,8 +71,8 @@ ENV API=true
 ENV LAYOUT=basic
 # TODO: show files in tree on hover
 ENV PREVIEW=false
-# TODO: support for multiple files
-ENV README_NAME=readme.md
+
+ENV 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
 
 ENV README_FIRST=false
 

docs/docs/configuration/readme.md

@@ -17,4 +17,4 @@ By default unsafe HTML inside markdown (such as `<script>`) will be escaped. You
 
 import EnvConfig from '@site/src/components/EnvConfig';
 
-<EnvConfig name="README_RENDER|README_NAME|README_FIRST|ALLOW_RAW_HTML|README_META" init="true|readme.md|false|false|true" values="true,false|<string>|true,false|true,false|true,false" versions="1.1|3.2|3.2|1.1|3.5" desc="|The case-insensitive file name which should be rendered|Render the readme above the file tree instead of below it.||Renders a .dbmeta.md file if it exists" />
+<EnvConfig name="README_RENDER|README_NAME|README_FIRST|ALLOW_RAW_HTML|README_META" init="true|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|false|false|true" values="true,false|<string>|true,false|true,false|true,false" versions="1.1|3.2|3.2|1.1|3.5" desc="|The case-insensitive file names seperated by a semicolon which should be rendered|Render the readme above the file tree instead of below it.||Renders a .dbmeta.md file if it exists" />

src/index.php

@@ -284,9 +284,11 @@ function downloadBatch(array $urls) {
   $[if `process.env.README_RENDER === "true"`]$
   // check if readme exists
   foreach ($sorted_files as $file) {
-    if (mb_strtolower($file->name) === "${{`process.env.README_NAME`}}$") {
-      $readme = $file;
-      break;
+    foreach (explode(';', "${{`process.env.README_NAME`}}$") as $readme_name) {
+      if (mb_strtolower($file->name) === $readme_name) {
+        $readme = $file;
+        break;
+      }
     }
   }
   $[end]$