yamabiiko/dot-files
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix main README

Browse Source
This commit is contained in:
Claudio Maradonna 2021-08-05 14:27:52 +02:00
parent 054f7bc239
commit ac2cebc5e5
Signed by untrusted user: claudiomaradonna
GPG Key ID: B1EDCB4C3B05C387
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,27 +4,19 @@ Unitoo standardized dotfiles.
## Directory Logic
The directory tree logic is the following: `program_name/program_name.conf` \
Each conf file can have
an associated Markdown file named `program_name/program_name.md`
The directory tree logic is the following: `program_name/program_name.extension`.
Each conf file can have an associated Markdown file named `program_name/program_name.md`.
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` \
\
**Examples:**
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`
**Examples:**
- `neovim/neovim.conf`
- `nginx/etc/nginx/nginx.conf`
- `nginx/etc/nginx/nginx.md`
## Syntax highlighting
In order to display the proper syntax highlighting on Gitlab,
edit the .gitattributes file accordingly:
```txt
neovim/*.conf gitlab-language=vim
emacs/*.conf gitlab-language=elisp
```
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
## Support