aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files 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
14 14
15You can map local directories to the following paths inside the container to customize the instance. 15You can map local directories to the following paths inside the container to customize the instance.
16 16
17### /app/repos 17### /app/repos/
18 18
19This is the recommended directory to store your git repositories. 19This is the recommended directory to store your git repositories.
20 20
@@ -28,27 +28,29 @@ Used for storing static assets such as images.
28 28
29Used to store specific Markdown files for repository descriptions. 29Used to store specific Markdown files for repository descriptions.
30 30
31### /app/etc/cgitrc (and /app/etc/ folder) 31- **Usage:** Set `repo.readme=/app/about/filename.md` in your config.
32
33### /app/etc/cgitrc and /app/etc/
32 34
33The main configuration file. It follows the standard `cgitrc` syntax. 35The main configuration file. It follows the standard `cgitrc` syntax.
34 36
35### /app/include 37### /app/include/
36 38
37Contains HTML fragments included in the pages. 39Contains HTML fragments included in the pages.
38 40
39- **head.html**: Used by the `head-include` setting. 41- **head.html**: Used by the `head-include` setting.
40- You can also place files here for the `header` or `footer` settings defined in `cgitrc`. 42- You can also place files here for the `header` or `footer` settings defined in `cgitrc`.
41 43
42### /app/filters 44### /app/filters/
43 45
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. 46Contains the original cgit filters and two custom filters required for the Material theme.
45 47You can add your own custom filter scripts to this directory.
46- **Usage:** Set `repo.readme=/app/about/filename.md` in your config.
47 48
48### /app/www/css 49### /app/www/css/
49 50
50Contains files for markdown syntax highlighting and color variables (`hl.css`, `md.css`, `colors.css`). 51Contains files for markdown syntax highlighting and color variables. [(See `www/css` folder)](www/css)
51 52
52## Examples 53## Examples
53 54
54Configuration examples are located in the `/examples` directory. This includes the configuration used for `git.igorek.dev`. 55Configuration examples are located in the [/examples](examples) directory.
56This includes the configuration used for [git.igorek.dev](https://git.igorek.dev).