more markdown warnings

2025-08-09 09:36:29 +02:00 · 2023-01-03 17:37:21 +02:00
parent 423a560392
commit 8d9c17001c
1 changed files with 44 additions and 62 deletions
--- a/README.md
+++ b/README.md
@@ -1,34 +1,33 @@
 # IFM - improved file manager

-## contents
+## Contents

- - [about](#about)
- - [features](#features)
- - [requirements](#requirements)
- - [installation](#installation)
- - [security information](#security-information)
- - [keybindings](#keybindings)
- - [configuration](#configuration)
- - [docker](#docker)
- - [screenshots](#screenshots)
- - [issues](#issues)
+ * [about](#about)
+ * [features](#features)
+ * [requirements](#requirements)
+ * [installation](#installation)
+ * [security information](#security-information)
+ * [keybindings](#keybindings)
+ * [configuration](#configuration)
+ * [docker](#docker)
+ * [screenshots](#screenshots)
+ * [issues](#issues)

 ## About

-The IFM is a web-based filemanager, which comes as a single file solution using
-HTML5, CSS3, JavaScript and PHP. You can test a [demo
-here](https://ifmdemo.gitea.de/).
+The IFM is a web-based filemanager, which comes as a single file solution using HTML5, CSS3, JavaScript and PHP. You can test a [demo here](https://ifmdemo.gitea.de/).

-<a href="https://youtu.be/owJepSas19Y"><img src="https://img.youtube.com/vi/owJepSas19Y/hqdefault.jpg"></a>
+[![IFM](https://img.youtube.com/vi/owJepSas19Y/hqdefault.jpg)](https://youtu.be/owJepSas19Y)

 The IFM uses the following resources:
+
 * [ACE Editor](https://ace.c9.io)
 * [Bootstrap v4](https://getbootstrap.com)
 * custom icon set generated with [Fontello](http://fontello.com/)
 * [jQuery](https://jquery.com)
 * [Mustache](https://mustache.github.io/)

-## features
+## Features

 * create/edit files and directories
 * copy/move files and directories
@@ -42,47 +41,37 @@ The IFM uses the following resources:
 ## Requirements

 * Client
-  * HTML5 and CSS3 compatible browser
-  * activated javascript
+  + HTML5 and CSS3 compatible browser
+  + activated javascript
 * Server
-  * PHP >= 5.6
-  * extensions
-    * bz2
-    * curl (for remote upload)
-    * fileinfo
-    * json
-    * ldap (only if LDAP based authentication is used)
-    * mbstring
-    * openssl (for remote uploads from https sources)
-    * phar
-    * posix
-    * zip
-    * zlib
+  + PHP >= 5.6
+  + extensions
+    - bz2
+    - curl (for remote upload)
+    - fileinfo
+    - json
+    - ldap (only if LDAP based authentication is used)
+    - mbstring
+    - openssl (for remote uploads from https sources)
+    - phar
+    - posix
+    - zip
+    - zlib

 ## Installation

-Just download the latest release of the IFM. You can find it
-[here](https://github.com/misterunknown/ifm/releases/latest). You can choose
-between the CDN version (dependencies like bootstrap, jquery etc. are loaded
-via CDN) or the "simple" version, which bundles all these dependencies.
+Just download the latest release of the IFM. You can find it [here](https://github.com/misterunknown/ifm/releases/latest). You can choose between the CDN version (dependencies like bootstrap, jquery etc. are loaded via CDN) or the "simple" version, which bundles all these dependencies.

-The minified versions (`*.min.php`) are zipped via gzip. These versions are not
-recommended; if the filesize of the IFM is an issue for you, consider using the
-CDN versions.
+The minified versions (`*.min.php`) are zipped via gzip. These versions are not recommended; if the filesize of the IFM is an issue for you, consider using the CDN versions.

 ## Security information

-The IFM is usually locked to it's own directory, so you are not able to go
-above. You can change that by setting the `root_dir` in the scripts
-[configuration](https://github.com/misterunknown/ifm/wiki/Configuration).
+The IFM is usually locked to it's own directory, so you are not able to go above. You can change that by setting the `root_dir` in the scripts [configuration](https://github.com/misterunknown/ifm/wiki/Configuration).

-By default, it is not allowed to show or edit the `.htaccess` file. This is
-because you can configure the IFM via environment variables. Thus if anyone has
-the ability to edit the `.htaccess` file, he could overwrite the active
-configuration. [See
-also](https://github.com/misterunknown/ifm/wiki/Configuration).
+By default, it is not allowed to show or edit the `.htaccess` file. This is because you can configure the IFM via environment variables. Thus if anyone has the ability to edit the `.htaccess` file, he could overwrite the active
+configuration. [See also](https://github.com/misterunknown/ifm/wiki/Configuration).

-## Key bindings
+## Keybindings

 * <kbd>e</kbd> - edit / extract current file
 * <kbd>h</kbd><kbd>j</kbd><kbd>k</kbd><kbd>l</kbd> - vim-style navigation (alternative to arrow keys)
@@ -106,7 +95,7 @@ also](https://github.com/misterunknown/ifm/wiki/Configuration).

 See [configuration](https://github.com/misterunknown/ifm/wiki/Configuration).

-### authentication
+### Authentication

 See [authentication](https://github.com/misterunknown/ifm/wiki/Authentication).

@@ -131,8 +120,7 @@ docker run --rm -d --name ifm -p 8080:80 -v /path/to/data:/var/www ifm:latest

 ### Specify user/group

-By default IFM runs as user www-data (uid/gid 33). If you need to change that,
-you can set the UID and GID with the following environment variables:
+By default IFM runs as user www-data (uid/gid 33). If you need to change that, you can set the UID and GID with the following environment variables:

 ```bash
 docker run ... -e IFM_DOCKER_UID=1000 -e IFM_DOCKER_GID=100 ifm:latest
@@ -140,17 +128,13 @@ docker run ... -e IFM_DOCKER_UID=1000 -e IFM_DOCKER_GID=100 ifm:latest

 ### Other configuration

-The script is located at `/usr/local/share/webapps/ifm/index.php`. By default
-the `root_dir` is set to /var/www, so you can mount any directory at this
-location. If you want to bind the corresponding host directory, you can do the
-following:
+The script is located at `/usr/local/share/webapps/ifm/index.php`. By default the `root_dir` is set to /var/www, so you can mount any directory at this location. If you want to bind the corresponding host directory, you can do the following:

 ```bash
 docker run --rm -i -p "8080:80" -v "/var/www:/var/www" ifm
 ```

-The scripts configuration can be changed by adjusting the corresponding
-environment variables. For example:
+The scripts configuration can be changed by adjusting the corresponding environment variables. For example:

 ```bash
 docker run --rm -i -p "8080:80" -v /var/www:/var/www \
@@ -159,17 +143,15 @@ docker run --rm -i -p "8080:80" -v /var/www:/var/www \
  ifm
 ```

-You can get a complete list of environment variables
-[here](https://github.com/misterunknown/ifm/wiki/Configuration#configuration-options).
+You can get a complete list of environment variables [here](https://github.com/misterunknown/ifm/wiki/Configuration#configuration-options).

-## screenshots
+## Screenshots

 <a href="https://misterunknown.de/static/ifm_screenshot_desktop_filelist.png"><img src="https://misterunknown.de/static/ifm_screenshot_desktop_filelist.png" height="300px"></a>
 <a href="https://misterunknown.de/static/ifm_screenshot_mobile_filelist.png"><img src="https://misterunknown.de/static/ifm_screenshot_mobile_filelist.png" height="300px"></a>
 <a href="https://misterunknown.de/static/ifm_screenshot_desktop_remote_upload.png"><img src="https://misterunknown.de/static/ifm_screenshot_desktop_remote_upload.png" height="300px"></a>
 <a href="https://misterunknown.de/static/ifm_screenshot_mobile_editfile.png"><img src="https://misterunknown.de/static/ifm_screenshot_mobile_editfile.png" height="300px"></a>

-## issues
+## Issues

-If you happen to find an error or miss a feature, you can create an issue on
-Github.
+If you happen to find an error or miss a feature, you can create an issue on Github.