mirror of
https://github.com/scopatz/nanorc
synced 2025-06-21 05:50:10 +02:00
a770c8b239
For better organisation the nanorc files will go to a folder. The install script should translate the themed nanorc files to the final files. The install script should be the official instalation method.
118 lines
3.6 KiB
Markdown
118 lines
3.6 KiB
Markdown
# Improved Nano Syntax Highlighting Files
|
|
|
|
This repository holds ``{lang}.nanorc`` files that have improved definitions of syntax highlighting for various languages.
|
|
|
|
For readability will use `$install_path` for the path of your choose (in *system wide* the path is always `/usr/share/nano-syntax-highlighting/`).
|
|
|
|
# Installation
|
|
|
|
There are three ways to install this repo.
|
|
|
|
## 1. Automatic installer
|
|
|
|
Copy the following code to download and run the installer script:
|
|
|
|
```sh
|
|
curl https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh | sh
|
|
```
|
|
|
|
If your machine doesn't have `curl` command, use this code:
|
|
|
|
```sh
|
|
wget https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh -O- | sh
|
|
```
|
|
|
|
### Note:
|
|
|
|
Some syntax definitions which exist in Nano upstream may be preferable to the ones provided by this package.
|
|
The ` install.sh` script may be run with `-l` or `--lite` to insert the included syntax definitions from this package with *lower* precedence than the ones provided by the standard package.
|
|
|
|
## 2. Package managers
|
|
|
|
The follow table lists all systems with this package published.
|
|
Fell free to add your official package manager.
|
|
> Systems that are based in others' package managers or repositories are compatible. For example: `pacman/aur` based systems are compatible with `Arch Linux`.
|
|
|
|
| System | Command |
|
|
| --- | --- |
|
|
| Arch Linux | `aurman -S nano-syntax-highlighting-git` or `aurman -Ss nano-syntax-highlight` |
|
|
|
|
## 3. Clone repo (copy the files)
|
|
|
|
The files should be placed inside of the `~/.nano/` directory.
|
|
|
|
> You can put the files in another directory inside the correct `.nano` folder.
|
|
> For example: `~/.nano/nanorc/`.
|
|
|
|
For user, only run:
|
|
|
|
`git clone git@github.com:scopatz/nanorc.git $install_path` or
|
|
`git clone https://github.com/scopatz/nanorc.git $install_path`
|
|
|
|
For system wide, run:
|
|
|
|
`sudo git clone https://github.com/scopatz/nanorc.git $install_path`
|
|
|
|
# Configuration
|
|
|
|
After installation, you need to inform `nano` to used the new highlight files.
|
|
The configuration file is located at `~/.nanorc`, for users, and at `/etc/nanorc`, for system wide.
|
|
> If this file doesn't exist, create a new one.
|
|
|
|
Again there are three ways:
|
|
|
|
## 1. Include all
|
|
|
|
Append the content of the folder in one line, with wildcard:
|
|
|
|
`echo "include $install_path/*.nanorc" >> ~/.nanorc` or
|
|
`echo "include $install_path/*.nanorc" >> /etc/nanorc`
|
|
|
|
## 2. Include/append our `nanorc` file
|
|
|
|
Simply run:
|
|
|
|
`cat $install_path/nanorc >> ~/.nanorc` or
|
|
`cat $install_path/nanorc >> /etc/nanorc`
|
|
|
|
## 3. One by one
|
|
|
|
Add your preferable languages one by onento the file. For example:
|
|
|
|
```
|
|
## C/C++
|
|
include "~/.nano/c.nanorc"
|
|
```
|
|
|
|
# Themes - WIP
|
|
|
|
There are three themes you can use:
|
|
- original: only nano's approximate default highlight.
|
|
- project: only scopatz's highlight.
|
|
- custom: highlight, GUI and shortcuts.
|
|
|
|
|
|
# Tricks & Tweaks
|
|
|
|
## MacOS
|
|
|
|
`\<` and `\>` are regular character escapes on MacOS.
|
|
The bug is fixed in Nano, but this might be a problem if you are using an older version
|
|
If this is the case, replace them respectively with `[[:<:]]` and `[[:>:]]`.
|
|
This is reported in [Issue 52](https://github.com/scopatz/nanorc/issues/52).
|
|
|
|
## New Features
|
|
|
|
Sometimes new features are pending in nano's project issues.
|
|
A view in that issues it can be helpful. See GNU Project link in the end.
|
|
|
|
|
|
# Acknowledgements
|
|
|
|
- [Nano Editor](https://www.nano-editor.org) for some `nanorc` files.
|
|
- [GNU Project](https://savannah.gnu.org/projects/nano/) for hosting the `nano`'s git and issues.
|
|
- [nanorc-mac](https://github.com/richrad/nanorc-mac) for the themes idea.
|
|
- [Bruce Barnert](http://www.grymoire.com/Unix/Sed.html#toc-uh-5) for good `sed` documentation.
|
|
|
|
- And to all contributors!
|