Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use footer links #294

Merged
merged 1 commit into from Jul 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
77 changes: 52 additions & 25 deletions docs/en/src/SUMMARY.md
@@ -1,28 +1,55 @@
A hackable, minimal, fast TUI file explorer
===========================================

- [Introduction](introduction.md)
- [Quickstart](quickstart.md)
- [Install](install.md)
- [Post Install](post-install.md)
- [Configuration](configuration.md)
- [General Config](general-config.md)
- [Modes](modes.md)
- [Message](message.md)
- [Layouts](layouts.md)
- [Node Types](node_types.md)
- [Style](style.md)
- [Sorting](sorting.md)
- [Filtering](filtering.md)
- [Default Key Bindings](default-key-bindings.md)
- [Plugin](plugin.md)
- [Installing Plugins](installing-plugins.md)
- [Writing Plugins](writing-plugins.md)
- [Awesome Plugins](awesome-plugins.md)
- [Integration](integration.md)
- [Awesome Integrations](awesome-integrations.md)
- [TODO](todo.md)
- [Alternatives](alternatives.md)
- [Upgrade Guide](upgrade-guide.md)
- [Community](community.md)
- [Contribute](contribute.md)
- [Introduction][1]
- [Quickstart][2]
- [Install][3]
- [Post Install][4]
- [Configuration][5]
- [General Config][6]
- [Modes][7]
- [Message][8]
- [Layouts][9]
- [Node Types][10]
- [Style][11]
- [Sorting][12]
- [Filtering][13]
- [Default Key Bindings][14]
- [Plugin][15]
- [Installing Plugins][16]
- [Writing Plugins][17]
- [Awesome Plugins][18]
- [Integration][19]
- [Awesome Integrations][20]
- [TODO][21]
- [Alternatives][22]
- [Upgrade Guide][23]
- [Community][24]
- [Contribute][25]


[1]:introduction.md
[2]:quickstart.md
[3]:install.md
[4]:post-install.md
[5]:configuration.md
[6]:general-config.md
[7]:modes.md
[8]:message.md
[9]:layouts.md
[10]:node_types.md
[11]:style.md
[12]:sorting.md
[13]:filtering.md
[14]:default-key-bindings.md
[15]:plugin.md
[16]:installing-plugins.md
[17]:writing-plugins.md
[18]:awesome-plugins.md
[19]:integration.md
[20]:awesome-integrations.md
[21]:todo.md
[22]:alternatives.md
[23]:upgrade-guide.md
[24]:community.md
[25]:contribute.md
41 changes: 28 additions & 13 deletions docs/en/src/alternatives.md
Expand Up @@ -3,17 +3,32 @@ Alternatives

These are the alternative TUI/CLI file managers/explorers you might want to check out (in no particular order).

- [nnn](https://github.com/jarun/nnn/)
- [vifm](https://github.com/vifm/vifm)
- [ranger](https://github.com/ranger/ranger)
- [lf](https://github.com/gokcehan/lf)
- [joshuto](https://github.com/kamiyaa/joshuto)
- [fff](https://github.com/dylanaraps/fff)
- [mc](https://github.com/MidnightCommander/mc)
- [broot](https://github.com/Canop/broot)
- [hunter](https://github.com/rabite0/hunter)
- [noice](https://github.com/RichardHyde/noice)
- [clifm](https://github.com/pasqu4le/clifm)
- [clifm](https://github.com/leo-arch/clifm) (non curses)
- [nnn][1]
- [vifm][2]
- [ranger][3]
- [lf][4]
- [joshuto][5]
- [fff][6]
- [mc][7]
- [broot][8]
- [hunter][9]
- [noice][10]
- [clifm][11]
- [clifm][12] (non curses)

[add more](community.md)
[add more][13]


[1]:https://github.com/jarun/nnn/
[2]:https://github.com/vifm/vifm
[3]:https://github.com/ranger/ranger
[4]:https://github.com/gokcehan/lf
[5]:https://github.com/kamiyaa/joshuto
[6]:https://github.com/dylanaraps/fff
[7]:https://github.com/MidnightCommander/mc
[8]:https://github.com/Canop/broot
[9]:https://github.com/rabite0/hunter
[10]:https://github.com/RichardHyde/noice
[11]:https://github.com/pasqu4le/clifm
[12]:https://github.com/leo-arch/clifm
[13]:community.md
26 changes: 18 additions & 8 deletions docs/en/src/awesome-integrations.md
Expand Up @@ -4,31 +4,41 @@ Awesome Integrations
Here's a list of awesome xplr integrations that you might want to check out.

If none of the following integrations work for you, you can create your own and
[let us know](https://github.com/sayanarijit/xplr/discussions/categories/show-and-tell).
[let us know][1].


Categories
----------

- [Editor](#editor)
- [Shell](#shell)
- [Security Tools](#security-tools)
- [Editor][2]
- [Shell][3]
- [Security Tools][4]


Editor
------

- [xplr.vim](https://github.com/sayanarijit/xplr.vim)
- [vim-floaterm](https://github.com/voldikss/vim-floaterm#xplr)
- [xplr.vim][5]
- [vim-floaterm][6]


Shell
-----

- [powerlevel10k](https://github.com/romkatv/powerlevel10k/blob/191d1b89e325ee3b6d2d75a394654aaf4f077a7c/internal/p10k.zsh#L4756-L4768)
- [powerlevel10k][7]


Security Tools
--------------

- [gpg-tui](https://github.com/orhun/gpg-tui#importreceive)
- [gpg-tui][8]


[1]:https://github.com/sayanarijit/xplr/discussions/categories/show-and-tell
[2]:#editor
[3]:#shell
[4]:#security-tools
[5]:https://github.com/sayanarijit/xplr.vim
[6]:https://github.com/voldikss/vim-floaterm#xplr
[7]:https://github.com/romkatv/powerlevel10k/blob/191d1b89e325ee3b6d2d75a394654aaf4f077a7c/internal/p10k.zsh#L4756-L4768
[8]:https://github.com/orhun/gpg-tui#importreceive
62 changes: 42 additions & 20 deletions docs/en/src/awesome-plugins.md
Expand Up @@ -3,52 +3,74 @@ Awesome Plugins

Here's a list of awesome xplr plugins that you might want to check out. If none
of the following plugins work for you, it's very easy to
[write your own](./writing-plugins.md).
[write your own][1].


Categories
----------

- [Integration](#integration)
- [Theme](#theme)
- [Integration][2]
- [Theme][3]


Integration
-----------

- [dragon.xplr](https://github.com/sayanarijit/dragon.xplr)
Drag and drop files using [dragon](https://github.com/mwh/dragon).
- [dragon.xplr][4]
Drag and drop files using [dragon][5].

- [dua-cli.xplr](https://github.com/sayanarijit/dua-cli.xplr)
Get the disk usage using [dua-cli](https://github.com/Byron/dua-cli) with
- [dua-cli.xplr][6]
Get the disk usage using [dua-cli][7] with
selection support.

- [fzf.xplr](https://github.com/sayanarijit/fzf.xplr)
Fuzzy search using [fzf](https://github.com/junegunn/fzf) to focus on a file
- [fzf.xplr][8]
Fuzzy search using [fzf][9] to focus on a file
or enter into a directory.

- [preview-tabbed.xplr](https://github.com/sayanarijit/preview-tabbed.xplr)
Preview paths using suckless [tabbed](https://tools.suckless.org/tabbed/) and
[nnn preview-tabbed](https://github.com/jarun/nnn/blob/master/plugins/preview-tabbed).
- [preview-tabbed.xplr][10]
Preview paths using suckless [tabbed][11] and
[nnn preview-tabbed][12].

- [trash-cli.xplr](https://github.com/sayanarijit/trash-cli.xplr)
- [trash-cli.xplr][13]
Trash files and directories using
[trash-cli](https://github.com/andreafrancia/trash-cli).
[trash-cli][14].

- [xclip.xplr](https://github.com/sayanarijit/xclip.xplr)
- [xclip.xplr][15]
Copy and paste with system clipboard using
[xclip](https://github.com/astrand/xclip).
[xclip][16].

- [zoxide.xplr](https://github.com/sayanarijit/zoxide.xplr)
Change directory using the [zoxide](https://github.com/ajeetdsouza/zoxide)
- [zoxide.xplr][17]
Change directory using the [zoxide][18]
database.


Theme
-----

- [material-landscape.xplr](https://github.com/sayanarijit/material-landscape.xplr)
- [material-landscape.xplr][19]
Material Landscape

- [material-landscape2.xplr](https://github.com/sayanarijit/material-landscape2.xplr)
- [material-landscape2.xplr][20]
Material Landscape 2


[1]:./writing-plugins.md
[2]:#integration
[3]:#theme
[4]:https://github.com/sayanarijit/dragon.xplr
[5]:https://github.com/mwh/dragon
[6]:https://github.com/sayanarijit/dua-cli.xplr
[7]:https://github.com/Byron/dua-cli
[8]:https://github.com/sayanarijit/fzf.xplr
[9]:https://github.com/junegunn/fzf
[10]:https://github.com/sayanarijit/preview-tabbed.xplr
[11]:https://tools.suckless.org/tabbed/
[12]:https://github.com/jarun/nnn/blob/master/plugins/preview-tabbed
[13]:https://github.com/sayanarijit/trash-cli.xplr
[14]:https://github.com/andreafrancia/trash-cli
[15]:https://github.com/sayanarijit/xclip.xplr
[16]:https://github.com/astrand/xclip
[17]:https://github.com/sayanarijit/zoxide.xplr
[18]:https://github.com/ajeetdsouza/zoxide
[19]:https://github.com/sayanarijit/material-landscape.xplr
[20]:https://github.com/sayanarijit/material-landscape2.xplr
8 changes: 6 additions & 2 deletions docs/en/src/community.md
Expand Up @@ -5,7 +5,11 @@ Building an active community of awesome people and learning stuff together is
one of my reasons to publish this tool and maintain it. Hence, please feel free
to reach out via your preferred way.

- Real-time chat lovers can [**join our discord channel**](https://discord.gg/JmasSPCcz3).
- Forum discussion veterans can [**start a new GitHub discussion**](https://github.com/sayanarijit/xplr/discussions).
- Real-time chat lovers can [**join our discord channel**][1].
- Forum discussion veterans can [**start a new GitHub discussion**][2].

BTW I like Miyazaki and Shinkai works.


[1]:https://discord.gg/JmasSPCcz3
[2]:https://github.com/sayanarijit/xplr/discussions
22 changes: 15 additions & 7 deletions docs/en/src/configuration.md
@@ -1,9 +1,9 @@
Configuration
=============

xplr can be configured using [Lua](https://www.lua.org/) via a special file
xplr can be configured using [Lua][1] via a special file
named `init.lua`
([example](https://github.com/sayanarijit/xplr/blob/main/src/init.lua)), which
([example][2]), which
can be placed in `~/.config/xplr/` (user specific) or `/etc/xplr/` (global)
depending on the use case.

Expand All @@ -20,7 +20,7 @@ How Config Is Loaded
--------------------

When xplr loads, it first executes the built-in
[init.lua](https://github.com/sayanarijit/xplr/blob/main/src/init.lua) to set
[init.lua][2] to set
the default values, which is then overwritten by another config file, if found
using the following lookup order:

Expand All @@ -33,7 +33,15 @@ config
The xplr configuration, exposed as `xplr.config` Lua API contains the
following fields:

- [general](general-config.md)
- [modes](modes.md)
- [layouts](layouts.md)
- [node_types](node_types.md)
- [general][3]
- [modes][4]
- [layouts][5]
- [node_types][6]


[1]:https://www.lua.org/
[2]:https://github.com/sayanarijit/xplr/blob/main/src/init.lua
[3]:general-config.md
[4]:modes.md
[5]:layouts.md
[6]:node_types.md
8 changes: 6 additions & 2 deletions docs/en/src/configure.md
Expand Up @@ -14,14 +14,14 @@ echo version = '"'${version:?}'"' > ~/.config/xplr/init.lua
```

Then
**[copy from here](https://github.com/sayanarijit/xplr/blob/main/src/init.lua)**
**[copy from here][1]**
and remove / comment out what you don't want to customize.

> **Note:** You don't generally need to create the config file. You can use the
> default configuration for basic operations. However, creating the config file
> is recommended because the project is in its early stage and the defaults
> might change. Creating the config file will save you from unexpected behavior
> when you [upgrade](upgrade-guide.md).
> when you [upgrade][2].
> Also, the default configuration is very minimal (just enough to get you
> started) and you'll probably want to adjust it to suit your workflow.

Expand All @@ -32,3 +32,7 @@ Run
```
xplr
```


[1]:https://github.com/sayanarijit/xplr/blob/main/src/init.lua
[2]:upgrade-guide.md
12 changes: 9 additions & 3 deletions docs/en/src/contribute.md
Expand Up @@ -2,7 +2,7 @@ If you like xplr, and want to contribute, that would be really awesome.

You can contribute to this project in the following ways

- Contribute your time and expertise (read [CONTRIBUTING.md](https://github.com/sayanarijit/xplr/blob/main/CONTRIBUTING.md) for instructions).
- Contribute your time and expertise (read [CONTRIBUTING.md][1] for instructions).
- **Developers:** You can help me improve my code, fix things, implement features etc.
- **Repository maintainers:** You can save the users from the pain of managing xplr in their system manually.
- **Code Reviewers:** Teach me your ways of code.
Expand All @@ -11,9 +11,15 @@ You can contribute to this project in the following ways


- Contribute by donating.
- You can [fuel me with coins of encouragement](https://opencollective.com/xplr) or [buy me a coffee](https://ko-fi.com/sayanarijit).
- You can [fuel me with coins of encouragement][2] or [buy me a coffee][3].

For further queries or concern related to `xplr`, [just ask us](community.md).
For further queries or concern related to `xplr`, [just ask us][4].

### Backers
<a href="https://opencollective.com/xplr#backer"><img src="https://opencollective.com/xplr/tiers/backer.svg?width=890" /></a>


[1]:https://github.com/sayanarijit/xplr/blob/main/CONTRIBUTING.md
[2]:https://opencollective.com/xplr
[3]:https://ko-fi.com/sayanarijit
[4]:community.md