aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTolmachev Igor <me@igorek.dev>2026-01-07 04:09:27 +0900
committerTolmachev Igor <me@igorek.dev>2026-01-07 04:09:27 +0900
commitda07215a89afe057e1f1642a2e45cc86e1fd59c3 (patch)
treee965fa891da43b7527b6fd84ebc6dfb85633ceec /README.md
parent5b5d5a2925be5b941c210b4daed8f1dc0fa0a52d (diff)
downloadcgit_material_docker-da07215a89afe057e1f1642a2e45cc86e1fd59c3.tar.gz
cgit_material_docker-da07215a89afe057e1f1642a2e45cc86e1fd59c3.zip
Improve image structure
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/README.md b/README.md
index 4813421..6448380 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,17 @@ You can map local directories to the following paths inside the container to cus
18 18
19This is the recommended directory to store your git repositories. 19This is the recommended directory to store your git repositories.
20 20
21### /app/etc/cgitrc 21### /app/www/static/
22
23Used for storing static assets such as images.
24
25- **Note:** When referencing these files in `cgitrc`, write the path relative to `/app/www/`.
26
27### /app/about/
28
29Used to store specific Markdown files for repository descriptions.
30
31### /app/etc/cgitrc (and /app/etc/ folder)
22 32
23The main configuration file. It follows the standard `cgitrc` syntax. 33The main configuration file. It follows the standard `cgitrc` syntax.
24 34
@@ -33,14 +43,12 @@ Contains HTML fragments included in the pages.
33 43
34Contains the original cgit filters and two custom filters required for the Material theme. You can add your own custom filter scripts to this directory. 44Contains the original cgit filters and two custom filters required for the Material theme. You can add your own custom filter scripts to this directory.
35 45
36### /app/www/static/ 46- **Usage:** Set `repo.readme=/app/about/filename.md` in your config.
37 47
38Used for storing static assets such as images. 48### /app/www/css
39 49
40- **Note:** When referencing these files in `cgitrc`, write the path relative to `/app/www/`. 50Contains files for markdown syntax highlighting and color variables (`hl.css`, `md.css`, `colors.css`).
41 51
42### /app/about/ 52## Examples
43
44Used to store specific Markdown files for repository descriptions.
45 53
46- **Usage:** Set `repo.readme=/app/about/filename.md` in your config. 54Configuration examples are located in the `/examples` directory. This includes the configuration used for `git.igorek.dev`.