https://github.com/sayanarijit/offline-docs.xplr
Fetch the appropriate version of xplr docs and browse offline
https://github.com/sayanarijit/offline-docs.xplr
Last synced: 5 months ago
JSON representation
Fetch the appropriate version of xplr docs and browse offline
- Host: GitHub
- URL: https://github.com/sayanarijit/offline-docs.xplr
- Owner: sayanarijit
- License: mit
- Created: 2022-05-24T11:32:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T06:07:15.000Z (over 1 year ago)
- Last Synced: 2025-03-30T19:23:19.367Z (6 months ago)
- Language: Lua
- Homepage: https://xplr.dev
- Size: 11.7 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Offline Docs
This plugin makes it easy to fetch the appropriate version of xplr docs and browse offline.
## Usage
- Type : ? to browse the offline docs.
- Delete the docs directory and try the same keys to re-fetch the docs.
## Requirements
- curl
- tar
## Installation
### Install using xpm.xplr
```lua
require("xpm").setup({
-- ...
{ name = "sayanarijit/offline-docs.xplr" },
-- ...
})
```
### Install manually
- Add the following line in `~/.config/xplr/init.lua`
```lua
local home = os.getenv("HOME")
package.path = home
.. "/.config/xplr/plugins/?/init.lua;"
.. home
.. "/.config/xplr/plugins/?.lua;"
.. package.path
```
- Clone the plugin
```bash
mkdir -p ~/.config/xplr/plugins
git clone https://github.com/sayanarijit/offline-docs.xplr ~/.config/xplr/plugins/offline-docs
```
- Require the module in `~/.config/xplr/init.lua`
```lua
require("offline-docs").setup()
-- Or
require("offline-docs").setup{
mode = "action",
key = "?",
local_path = os.getenv("HOME") .. "/.local/share/xplr/doc/" .. version
}
```