configurations/README.md

26 lines
700 B
Markdown
Raw Normal View History

2021-04-09 14:35:47 +02:00
# dot-files
2021-04-10 16:24:53 +02:00
Unitoo standardized dotfiles.
## Directory Logic
2021-04-10 16:29:35 +02:00
The directory tree logic is the following: `program_name/program_name.conf` \
Each conf file can have
2021-04-10 17:42:19 +02:00
an associated Markdown file named `program_name/program_name.md`
2021-04-10 16:29:35 +02:00
You can also put the conf inside the actual path
of the configuration file following this logic: \
`program_name/path/to/conf/program_name.conf,
2021-04-10 16:32:25 +02:00
program_name/path/to/conf/program_name.md`
2021-04-10 16:26:56 +02:00
**Examples:** `neovim/neovim.conf, nginx/etc/nginx/nginx.conf`
2021-04-10 16:24:53 +02:00
## Syntax highlighting
2021-04-10 16:32:25 +02:00
In order to display the proper syntax highlighting on Gitlab,
2021-04-10 17:42:19 +02:00
edit the .gitattributes file accordingly:
2021-04-10 16:24:53 +02:00
2021-04-10 16:26:56 +02:00
```txt
2021-04-10 16:35:32 +02:00
neovim/*.conf gitlab-language=vim
spacemacs/*.conf gitlab-language=elisp
2021-04-10 16:26:56 +02:00
```