ghmirrors/nanorc
1
0
Fork 0
mirror of https://github.com/scopatz/nanorc synced 2024-11-25 01:45:39 +01:00
Code Issues Releases Wiki Activity

Fix heading levels, remove quote sections

Browse Source
This commit is contained in:
Sandro 2019-09-13 13:36:00 +02:00 committed by GitHub
parent 66df684e08
commit d60e0a1b3a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
readme.md
View File

@ -2,11 +2,11 @@
This repository holds ``{lang}.nanorc`` files that have improved definitions of syntax highlighting for various languages.
# Installation
## Installation
There are three ways to install this repo.
## 1. Automatic installer
### 1. Automatic installer
Copy the following code to download and run the installer script:
@ -20,28 +20,29 @@ If your machine doesn't have `curl` command, use this code:
wget https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh -O- | sh
```
### Note:
#### 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
### 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` |
| System | Command |
| ---------- | ---------------------------------------- |
| Arch Linux | `aurman -Ss nano-syntax-highlight` |
| | `aurman -S nano-syntax-highlighting-git` |
## 3. Clone repo (copy the files)
### 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 readability will use `$install_path` for the path of your choose (in *system wide* the path is always `/usr/share/nano-syntax-highlighting/`).
You can put the files in another directory inside the correct `.nano` folder.
For example: `~/.nano/nanorc/`.
For readability will use `$install_path` for the path of your choose (in *system wide* the path is always `/usr/share/nano-syntax-highlighting/`).
For user, only run:
@ -52,29 +53,29 @@ For system wide, run:
`sudo git clone https://github.com/scopatz/nanorc.git $install_path`
# Configuration
## 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.
If this file doesn't exist, create a new one.
Again there are three ways:
## 1. Include all
### 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
### 2. Include/append our `nanorc` file
Simply run:
`cat $install_path/nanorc >> ~/.nanorc` or
`cat $install_path/nanorc >> /etc/nanorc`
## 3. One by one
### 3. One by one
Add your preferable languages one by onento the file. For example:
@ -83,15 +84,15 @@ Add your preferable languages one by onento the file. For example:
include "~/.nano/c.nanorc"
```
# Tricks & Tweaks
## Tricks & Tweaks
## MacOS
### 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).
# Acknowledgements
## Acknowledgements
Some of these files are derived from the original [Nano](https://www.nano-editor.org) editor [repo](https://git.savannah.gnu.org/cgit/nano.git)