Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nordtheme/dircolors
An arctic, north-bluish clean and elegant dircolors theme.
https://github.com/nordtheme/dircolors
bash cli colors dircolors hacktoberfest ls nord shell terminal zsh
Last synced: about 1 month ago
JSON representation
An arctic, north-bluish clean and elegant dircolors theme.
- Host: GitHub
- URL: https://github.com/nordtheme/dircolors
- Owner: nordtheme
- License: mit
- Created: 2017-01-14T11:21:18.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-31T18:47:33.000Z (over 1 year ago)
- Last Synced: 2024-05-02T03:46:42.424Z (8 months ago)
- Topics: bash, cli, colors, dircolors, hacktoberfest, ls, nord, shell, terminal, zsh
- Language: JavaScript
- Homepage: https://www.nordtheme.com/ports/dircolors
- Size: 711 KB
- Stars: 509
- Watchers: 11
- Forks: 106
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
- Codeowners: .github/codeowners
Awesome Lists containing this project
- awesome-nord - Dircolors
- awesome-nord - Dircolors
README
![]()
An arctic, north-bluish clean and elegant dircolors theme.
Designed for a fluent and clear workflow based on the Nord color palette.
## Getting started
Visit the [official website][nord-home] to learn all about the [features][nord-home#intro], how to [install and activate][nord-docs-home-install] the theme, supported [data and node types][nord-docs-home-types] and more from the [official documentations][nord-docs-home].
### Quick Start
Nord dircolors can be installed for all application that respect the `LS_COLORS` environment variable like GNU core utils [`ls`][wiki-ls], [`tree`][wiki-tree] or modern projects like [`fd`][gh-sharkdp/fd].
Download the [`dir_colors`][gh-tree-dir_colors] file and place it as `~/.dir_colors` in your [home directory][wiki-home_dir].
For more details see the [official installation & activation guide][nord-docs-home-install] as well as the [GNU `dircolors` documentations][gnu-docs-dircolors].
#### Latest Development State
To always use the latest development state of Nord dircolors, [clone the repository][repo] and create a [symbolic link][wiki-symlink] of the `src/dir_colors` file to `~/.dir_colors` in your [home directory][wiki-home_dir] afterwards:
```sh
ln -sr "$PWD/src/dir_colors" ~/.dir_colors
```
#### Activation
To activate and use Nord dircolors as your default color theme for all sessions, load the theme with `dircolors` by adding the following snippet to the configuration file of your shell (`~/.bashrc`, `~/.zshrc`, …):
```sh
test -r ~/.dir_colors && eval $(dircolors ~/.dir_colors)
```
## Features
Beautiful highlighting for all your bits and bytes.
Support for a wide range of data and node types — From symbolic links, executables up to file system permissions.
Directories with different file system permissions.
Various Unix file types like device files and domain sockets.
## Contributing
Nord is an open source project and we love to receive contributions from the [community][nord-comm]!
There are many ways to contribute, from [writing- and improving documentation and tutorials][nord-contrib-guide-docs], [reporting bugs][nord-contrib-guide-bugs], [submitting enhancement suggestions][nord-contrib-guide-enhance] that can be added to Nord by [submitting pull requests][nord-contrib-guide-pr].
Please take a moment to read Nord's full [contributing guide][nord-contrib-guide] to learn about the development process, the project's used [styleguides][nord-contrib-guide-styles], [branch organization][nord-contrib-guide-branching] and [versioning][nord-contrib-guide-versioning] model.
The guide also includes information about [minimal, complete, and verifiable examples][nord-contrib-guide-mcve] and other ways to contribute to the project like [improving existing issues][nord-contrib-guide-impr-issues] and [giving feedback on issues and pull requests][nord-contrib-guide-feedback].
Copyright © 2016-present Sven Greb
[gh-sharkdp/fd]: https://github.com/sharkdp/fd
[gh-tree-dir_colors]: https://github.com/nordtheme/dircolors/blob/develop/src/dir_colors
[gnu-docs-dircolors]: https://www.gnu.org/software/coreutils/manual/html_node/dircolors-invocation.html
[nord-comm]: https://www.nordtheme.com/community
[nord-contrib-guide-branching]: https://github.com/nordtheme/.github/blob/main/contributing.md#branch-organization
[nord-contrib-guide-bugs]: https://github.com/nordtheme/.github/blob/main/contributing.md#bug-reports
[nord-contrib-guide-docs]: https://github.com/nordtheme/.github/blob/main/contributing.md#documentations
[nord-contrib-guide-enhance]: https://github.com/nordtheme/.github/blob/main/contributing.md#enhancement-suggestions
[nord-contrib-guide-feedback]: https://github.com/nordtheme/.github/blob/main/contributing.md#feedback
[nord-contrib-guide-impr-issues]: https://github.com/nordtheme/.github/blob/main/contributing.md#improve-issues
[nord-contrib-guide-mcve]: https://github.com/nordtheme/.github/blob/main/contributing.md#mcve
[nord-contrib-guide-pr]: https://github.com/nordtheme/.github/blob/main/contributing.md#pull-requests
[nord-contrib-guide-styles]: https://github.com/nordtheme/.github/blob/main/contributing.md#style-guides
[nord-contrib-guide-versioning]: https://github.com/nordtheme/.github/blob/main/contributing.md#versioning
[nord-contrib-guide]: https://github.com/nordtheme/.github/blob/main/contributing.md
[nord-docs-home-install]: https://www.nordtheme.com/docs/ports/dircolors/installation
[nord-docs-home-types]: https://www.nordtheme.com/docs/ports/dircolors/type-support
[nord-docs-home]: https://www.nordtheme.com/docs/ports/dircolors
[nord-home]: https://www.nordtheme.com/ports/dircolors
[nord-home#intro]: https://www.nordtheme.com/ports/dircolors#introduction
[repo]: https://github.com/nordtheme/dircolors
[wiki-home_dir]: https://en.wikipedia.org/wiki/Home_directory
[wiki-ls]: https://en.wikipedia.org/wiki/Ls
[wiki-symlink]: https://en.wikipedia.org/wiki/Symbolic_link
[wiki-tree]: https://en.wikipedia.org/wiki/Tree_(command)