diff options
| -rw-r--r-- | README.md | 22 |
1 files changed, 12 insertions, 10 deletions
| @@ -14,7 +14,7 @@ docker run -d -p 80:80 igorechek06/cgit-material | |||
| 14 | 14 | ||
| 15 | You can map local directories to the following paths inside the container to customize the instance. | 15 | You 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 | ||
| 19 | This is the recommended directory to store your git repositories. | 19 | This 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 | ||
| 29 | Used to store specific Markdown files for repository descriptions. | 29 | Used 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 | ||
| 33 | The main configuration file. It follows the standard `cgitrc` syntax. | 35 | The main configuration file. It follows the standard `cgitrc` syntax. |
| 34 | 36 | ||
| 35 | ### /app/include | 37 | ### /app/include/ |
| 36 | 38 | ||
| 37 | Contains HTML fragments included in the pages. | 39 | Contains 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 | ||
| 44 | 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. | 46 | Contains the original cgit filters and two custom filters required for the Material theme. |
| 45 | 47 | You 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 | ||
| 50 | Contains files for markdown syntax highlighting and color variables (`hl.css`, `md.css`, `colors.css`). | 51 | Contains files for markdown syntax highlighting and color variables. [(See `www/css` folder)](www/css) |
| 51 | 52 | ||
| 52 | ## Examples | 53 | ## Examples |
| 53 | 54 | ||
| 54 | Configuration examples are located in the `/examples` directory. This includes the configuration used for `git.igorek.dev`. | 55 | Configuration examples are located in the [/examples](examples) directory. |
| 56 | This includes the configuration used for [git.igorek.dev](https://git.igorek.dev). | ||
