fix main README
This commit is contained in:
parent
054f7bc239
commit
ac2cebc5e5
1 changed files with 6 additions and 14 deletions
20
README.md
20
README.md
|
@ -4,27 +4,19 @@ Unitoo standardized dotfiles.
|
||||||
|
|
||||||
## Directory Logic
|
## Directory Logic
|
||||||
|
|
||||||
The directory tree logic is the following: `program_name/program_name.conf` \
|
The directory tree logic is the following: `program_name/program_name.extension`.
|
||||||
Each conf file can have
|
Each conf file can have an associated Markdown file named `program_name/program_name.md`.
|
||||||
an associated Markdown file named `program_name/program_name.md`
|
|
||||||
|
|
||||||
You can also put the conf inside the actual path
|
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`
|
||||||
of the configuration file following this logic: `program_name/path/to/conf/program_name.conf` \
|
|
||||||
\
|
**Examples:**
|
||||||
**Examples:**
|
|
||||||
- `neovim/neovim.conf`
|
- `neovim/neovim.conf`
|
||||||
- `nginx/etc/nginx/nginx.conf`
|
- `nginx/etc/nginx/nginx.conf`
|
||||||
- `nginx/etc/nginx/nginx.md`
|
- `nginx/etc/nginx/nginx.md`
|
||||||
|
|
||||||
## Syntax highlighting
|
## Syntax highlighting
|
||||||
|
|
||||||
In order to display the proper syntax highlighting on Gitlab,
|
In order to display the proper syntax highlighting on Gitea, you should use the appropriate file extension as described here: https://github.com/alecthomas/chroma
|
||||||
edit the .gitattributes file accordingly:
|
|
||||||
|
|
||||||
```txt
|
|
||||||
neovim/*.conf gitlab-language=vim
|
|
||||||
emacs/*.conf gitlab-language=elisp
|
|
||||||
```
|
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue