From 95bfc8444393a1555ce37370bebae26dead1db5f Mon Sep 17 00:00:00 2001 From: Tolmachev Igor Date: Thu, 8 Jan 2026 00:58:53 +0900 Subject: Update README.md --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6448380..460dc06 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ docker run -d -p 80:80 igorechek06/cgit-material You can map local directories to the following paths inside the container to customize the instance. -### /app/repos +### /app/repos/ This is the recommended directory to store your git repositories. @@ -28,27 +28,29 @@ Used for storing static assets such as images. Used to store specific Markdown files for repository descriptions. -### /app/etc/cgitrc (and /app/etc/ folder) +- **Usage:** Set `repo.readme=/app/about/filename.md` in your config. + +### /app/etc/cgitrc and /app/etc/ The main configuration file. It follows the standard `cgitrc` syntax. -### /app/include +### /app/include/ Contains HTML fragments included in the pages. - **head.html**: Used by the `head-include` setting. - You can also place files here for the `header` or `footer` settings defined in `cgitrc`. -### /app/filters +### /app/filters/ -Contains the original cgit filters and two custom filters required for the Material theme. You can add your own custom filter scripts to this directory. - -- **Usage:** Set `repo.readme=/app/about/filename.md` in your config. +Contains the original cgit filters and two custom filters required for the Material theme. +You can add your own custom filter scripts to this directory. -### /app/www/css +### /app/www/css/ -Contains files for markdown syntax highlighting and color variables (`hl.css`, `md.css`, `colors.css`). +Contains files for markdown syntax highlighting and color variables. [(See `www/css` folder)](www/css) ## Examples -Configuration examples are located in the `/examples` directory. This includes the configuration used for `git.igorek.dev`. +Configuration examples are located in the [/examples](examples) directory. +This includes the configuration used for [git.igorek.dev](https://git.igorek.dev). -- cgit v1.2.3