Skip to content

Commit cce5654

Browse files
dimitry-ishenkodimitry-ishenko
committed
README.md: update
1 parent 75f5fcb commit cce5654

File tree

5 files changed

+148
-10
lines changed

5 files changed

+148
-10
lines changed

‎README.md‎

Lines changed: 72 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,84 @@
1-
# [devdocs](https://devdocs.io) + [fzf](https://github.com/junegunn/fzf) + [elinks](http://elinks.or.cz) = ☯
1+
# devdocs – offline DevDocs in your terminal ⚡️
22

3-
What happens when you combine _[devdocs](https://devdocs.io)_ API documentation, _[fzf](https://github.com/junegunn/fzf)_ fuzzy finder and _[elinks](http://elinks.or.cz)_ text-based browser?
3+
Combine [**DevDocs API documentation**](https://devdocs.io), the [**fzf fuzzy
4+
finder**](https://github.com/junegunn/fzf), and the [**elinks text-based
5+
browser**](http://elinks.or.cz)—all within your terminal. ☯
46

5-
![](./image/showcase.gif)
7+
![LOADING...](./image/showcase.gif)
68

7-
## Installation
9+
## 🚀 Why Use It?
10+
11+
* 🔎 **Lightning-fast search:** Use _fzf_ to filter docs instantly.
12+
* 🛠 **Offline-friendly:** Access 100+ documentation sets including HTML, CSS,
13+
JS, Python, C++, and more.
14+
* 🖥 **Terminal-native:** Works without a GUI using _elinks_.
15+
16+
## ⚙️ Usage
17+
18+
**devdocs** consists of three command-line tools:
19+
20+
* 🔭 **devopen** — Open a documentation entry or topic index.
21+
22+
<pre><code>Usage: <em>devopen</em> [-p|--preview] [<em>topic</em>] [<em>entry</em>]
23+
or: <em>devopen</em> -h|--help
24+
or: <em>devopen</em> -v|--version
25+
26+
If <em>topic</em> is omitted or set to ?, the entry will be searched
27+
in all available topics.
28+
29+
If <em>entry</em> is omitted, index page for the given topic will be shown.
30+
</code></pre>
31+
32+
* 🔍 **devgrep** — Fuzzy search for entries across one or all documentation topics.
33+
34+
<pre><code>Usage: <em>devgrep</em> [-p|--preview] [<em>topic</em>] [<em>pattern</em>]
35+
or: <em>devgrep</em> -h|--help
36+
or: <em>devgrep</em> -v|--version
37+
38+
If <em>topic</em> is omitted or set to ?, the pattern will be searched in
39+
all available topics.
40+
41+
If <em>pattern</em> is omitted, all entries for the given topic will be searched.
42+
</code></pre>
43+
44+
* 🧰 **devmanage** — Install, remove, and update documentation topics.
45+
46+
<pre><code>Usage: devmanage -a|--all
47+
or: <em>devmanage</em> -l|--local
48+
or: <em>devmanage</em> -u|--update
49+
or: <em>devmanage</em> -i|--install <em>topic</em> [<em>topic</em>] ...
50+
or: <em>devmanage</em> -r|--remove <em>topic</em> [<em>topic</em>] ...
51+
or: <em>devmanage</em> -h|--help
52+
or: <em>devmanage</em> -v|--version
53+
54+
Where:
55+
-a|--all Show all topics available online.
56+
-l|--local Show locally cached topics.
57+
-u|--update Update all local topics.
58+
59+
-i|--install Cache one or more topics locally.
60+
-r|--remove Remove local topic(s).
61+
</code></pre>
62+
63+
You can use the _--preview_ option with both **devgrep** and **devopen**:
64+
65+
![LOADING...](./image/preview.gif)
66+
67+
## 📦 Installation
868

969
### Binary
1070

1171
Debian/Ubuntu/etc:
1272

1373
```shell
14-
$ sudo add-apt-repository ppa:ppa-verse/devdocs
15-
$ sudo apt install devdocs
74+
sudo add-apt-repository ppa:ppa-verse/devdocs
75+
sudo apt install devdocs
1676
```
77+
1778
```shell
18-
$ apt list devdocs-data-*
19-
$ # find doc packages you are interested in and install them as well, eg:
20-
$ sudo apt install devdocs-data-css devdocs-data-html
79+
# find doc packages you are interested in and install them as well, eg:
80+
apt list devdocs-data-*
81+
sudo apt install devdocs-data-css devdocs-data-html
2182
```
2283

2384
RaspberryPi:
@@ -26,6 +87,7 @@ RaspberryPi:
2687
$ sudo add-apt-repository -S deb https://ppa.launchpadcontent.net/ppa-verse/devdocs/ubuntu jammy main
2788
$ sudo apt install devdocs
2889
```
90+
2991
```shell
3092
# install doc packages as above
3193
```
@@ -46,7 +108,7 @@ $ make install
46108
```
47109

48110
To install system-wide, change the last 3 commands above to:
49-
```shell
111+
```bash
50112
$ cmake -DSYSTEM_INSTALL=ON ..
51113
$ make
52114
$ sudo make install

‎image/preview.gif‎

1.39 MB
Loading

‎image/preview.tape‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Output preview.gif
2+
3+
Require devgrep
4+
Require devopen
5+
Require devmanage
6+
7+
Set Shell "bash"
8+
Set FontSize 16
9+
Set Width 1200
10+
Set Height 600
11+
Set Padding 10
12+
Set Theme "Hivacruz"
13+
14+
[email protected] "devopen --preview std::swap" Sleep 2 Enter
15+
Sleep 5 Up Sleep 5 Down Sleep 5
16+
Ctrl+C
17+
Sleep 2
18+
Enter
19+
20+
[email protected] "devgrep --preview c++ std::" Sleep 2 Enter
21+
Sleep 5
22+
Up@1 5
23+
Sleep 3
24+
[email protected] 5
25+
Ctrl+C
26+
Sleep 5

‎image/showcase.gif‎

-2.46 MB
Loading

‎image/showcase.tape‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Output showcase.gif
2+
3+
Require devgrep
4+
Require devopen
5+
Require devmanage
6+
7+
Set Shell "bash"
8+
Set FontSize 16
9+
Set Width 1200
10+
Set Height 600
11+
Set Padding 10
12+
Set Theme "Hivacruz"
13+
14+
[email protected] "devopen c" Sleep 2 Enter
15+
Sleep 5
16+
[email protected] "JJJJJ"
17+
Sleep 1
18+
[email protected] 6
19+
Sleep 2
20+
Enter
21+
Sleep 3
22+
[email protected] "JJJJJJJJJJJJJJJJJJJJJJJJJJJJ"
23+
Sleep 3
24+
Ctrl+C
25+
Sleep 2
26+
27+
Enter
28+
[email protected] "devmanage --install rust" Sleep .5 Enter
29+
Sleep 3
30+
31+
Enter
32+
[email protected] "devmanage --local" Sleep 2 Enter
33+
Sleep 5
34+
35+
Enter
36+
[email protected] "devgrep rust" Sleep 2 Enter
37+
Sleep 5
38+
[email protected] "std::any"
39+
Sleep 3
40+
Enter
41+
Sleep 5
42+
[email protected] "JJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJ"
43+
Sleep 2
44+
[email protected] "KKKKKKKKKK"
45+
Sleep 3
46+
Ctrl+C
47+
Sleep 2
48+
[email protected] 8
49+
Ctrl+C
50+
Sleep 5

0 commit comments

Comments
 (0)