mirror of
https://github.com/sharkdp/bat.git
synced 2025-02-22 04:48:48 +00:00
Use default Markdown syntax, closes #157
This commit is contained in:
parent
26d409db65
commit
9d92350cbb
3
.gitmodules
vendored
3
.gitmodules
vendored
@ -13,9 +13,6 @@
|
|||||||
[submodule "assets/themes/sublime-monokai-extended"]
|
[submodule "assets/themes/sublime-monokai-extended"]
|
||||||
path = assets/themes/sublime-monokai-extended
|
path = assets/themes/sublime-monokai-extended
|
||||||
url = https://github.com/jonschlinkert/sublime-monokai-extended
|
url = https://github.com/jonschlinkert/sublime-monokai-extended
|
||||||
[submodule "assets/syntaxes/Markdown-Extended"]
|
|
||||||
path = assets/syntaxes/Markdown-Extended
|
|
||||||
url = https://github.com/jonschlinkert/sublime-markdown-extended
|
|
||||||
[submodule "assets/syntaxes/Docker"]
|
[submodule "assets/syntaxes/Docker"]
|
||||||
path = assets/syntaxes/Docker
|
path = assets/syntaxes/Docker
|
||||||
url = https://github.com/asbjornenge/Docker.tmbundle
|
url = https://github.com/asbjornenge/Docker.tmbundle
|
||||||
|
38
README.md
38
README.md
@ -35,23 +35,23 @@ the plain file contents.
|
|||||||
|
|
||||||
Display a single file on the terminal
|
Display a single file on the terminal
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
> bat README.md
|
> bat README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
Display multiple files at once
|
Display multiple files at once
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
> bat src/*.rs
|
> bat src/*.rs
|
||||||
```
|
```
|
||||||
|
|
||||||
Explicitly specify the language
|
Explicitly specify the language
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
> yaml2json .travis.yml | json_pp | bat -l json
|
> yaml2json .travis.yml | json_pp | bat -l json
|
||||||
```
|
```
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
> curl -s https://raw.githubusercontent.com/sharkdp/bat/master/src/main.rs | bat -l rs
|
> curl -s https://raw.githubusercontent.com/sharkdp/bat/master/src/main.rs | bat -l rs
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -78,13 +78,13 @@ makepkg -si
|
|||||||
|
|
||||||
You can install a precompiled [`bat` package](https://www.freshports.org/textproc/bat) with pkg:
|
You can install a precompiled [`bat` package](https://www.freshports.org/textproc/bat) with pkg:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
pkg install bat
|
pkg install bat
|
||||||
```
|
```
|
||||||
|
|
||||||
or build it on your own from the FreeBSD ports:
|
or build it on your own from the FreeBSD ports:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
cd /usr/ports/textproc/bat
|
cd /usr/ports/textproc/bat
|
||||||
make install
|
make install
|
||||||
```
|
```
|
||||||
@ -93,7 +93,7 @@ make install
|
|||||||
|
|
||||||
You can install `bat` with [Homebrew](http://braumeister.org/formula/bat):
|
You can install `bat` with [Homebrew](http://braumeister.org/formula/bat):
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
brew install bat
|
brew install bat
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -102,7 +102,7 @@ brew install bat
|
|||||||
If you want to build to compile `bat` from source, you need Rust 1.24 or
|
If you want to build to compile `bat` from source, you need Rust 1.24 or
|
||||||
higher. You can then use `cargo` to build everything:
|
higher. You can then use `cargo` to build everything:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
cargo install bat
|
cargo install bat
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -120,41 +120,43 @@ To build your own language-set and theme, follow these steps:
|
|||||||
|
|
||||||
Create a folder with a syntax highlighting theme:
|
Create a folder with a syntax highlighting theme:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
BAT_CONFIG_DIR="$(bat cache --config-dir)"
|
BAT_CONFIG_DIR="$(bat cache --config-dir)"
|
||||||
|
|
||||||
mkdir -p "$BAT_CONFIG_DIR/themes"
|
mkdir -p "$BAT_CONFIG_DIR/themes"
|
||||||
cd "$BAT_CONFIG_DIR/themes"
|
cd "$BAT_CONFIG_DIR/themes"
|
||||||
|
|
||||||
# Download a theme, for example:
|
# Download a theme, for example:
|
||||||
git clone https://github.com/jonschlinkert/sublime-monokai-extended
|
git clone https://github.com/greggb/sublime-snazzy
|
||||||
|
|
||||||
# Create a 'Default.tmTheme' link
|
# Create a link for the default theme
|
||||||
ln -s "sublime-monokai-extended/Monokai Extended.tmTheme" Default.tmTheme
|
ln -sf "sublime-snazzy/Sublime Snazzy.tmTheme" Default.tmTheme
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a folder with language definition files:
|
Create a folder with language definition files:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
mkdir -p "$BAT_CONFIG_DIR/syntaxes"
|
mkdir -p "$BAT_CONFIG_DIR/syntaxes"
|
||||||
cd "$BAT_CONFIG_DIR/syntaxes"
|
cd "$BAT_CONFIG_DIR/syntaxes"
|
||||||
|
|
||||||
# Download some language definition files, for example:
|
# Download some language definition files, for example:
|
||||||
git clone https://github.com/sublimehq/Packages/
|
git clone https://github.com/sublimehq/Packages
|
||||||
rm -rf Packages/Markdown
|
git clone https://github.com/danro/LESS-sublime
|
||||||
git clone https://github.com/jonschlinkert/sublime-markdown-extended
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, use the following command to parse all these files into a binary
|
Finally, use the following command to parse all these files into a binary
|
||||||
cache:
|
cache:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
bat cache --init
|
bat cache --init
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Use `bat --list-languages` and `bat --list-themes` to check if all languages and themes are
|
||||||
|
available.
|
||||||
|
|
||||||
If you ever want to go back to the default settings, call:
|
If you ever want to go back to the default settings, call:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
bat cache --clear
|
bat cache --clear
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -2,10 +2,4 @@
|
|||||||
|
|
||||||
ASSET_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
ASSET_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
|
||||||
DEFAULT_MARKDOWN_SYNTAX="$ASSET_DIR/syntaxes/Packages/Markdown"
|
|
||||||
|
|
||||||
rm -rf "$DEFAULT_MARKDOWN_SYNTAX"
|
|
||||||
|
|
||||||
bat cache --init --source="$ASSET_DIR" --target="$ASSET_DIR"
|
bat cache --init --source="$ASSET_DIR" --target="$ASSET_DIR"
|
||||||
|
|
||||||
git -C "$ASSET_DIR/syntaxes/Packages" checkout "$DEFAULT_MARKDOWN_SYNTAX"
|
|
||||||
|
@ -1 +0,0 @@
|
|||||||
Subproject commit 7b7a83aeeaf3afc752f7d921b10051330557aa0e
|
|
Loading…
x
Reference in New Issue
Block a user