doks
0.9.3
Jika Anda memiliki dokumentasi yang tersebar di semua tempat (GitHub, Google Drive, dll.) Dan Anda menginginkan alat pencarian terpusat di atasnya, maka doks adalah untuk Anda.
Doks adalah alat CLI yang mengumpulkan dokumen yang berasal dari berbagai sumber (GitHub, Google Drive, dll.) Ke dalam mesin pencari (Lucene digunakan secara default untuk pengaturan lokal minimum tetapi Elasticsearch dapat digunakan sebagai gantinya).
Prosedur instalasi dapat ditemukan di Docs/Install.md.
Dokumentasi dapat ditemukan di folder Docs.
Pilih file konfigurasi yang akan digunakan dengan doks (secara default: $HOME/.doks/config/default.yml ):
❯ export DOKS_CONFIG_FILE=docs/examples/config/simple.yml Di sini kami menggunakan file konfigurasi sederhana dari dokumen/contoh/config/simple.yml. Dalam praktiknya, Anda tidak memerlukan ekspor ini, Anda hanya perlu meletakkan konfigurasi Anda di jalur default yang diharapkan $HOME/.doks/config/default.yml .
Langkah selanjutnya adalah mengindeks dokumen yang dirujuk dalam file konfigurasi untuk membuatnya dapat dicari:
❯ doks index
14:23:58 INFO - [wlezzar/jtab] cloning into ' /tmp/doks1910419821411559250 '
14:24:00 INFO - [wlezzar/jtab] 1 documents found !
14:24:00 INFO - [wlezzar/doks] cloning into ' /tmp/doks8654245137262434689 '
14:24:02 INFO - [wlezzar/doks] 0 documents found !
14:24:02 INFO - [adevinta/zoe] cloning into ' /tmp/doks756581970042346717 '
14:24:04 INFO - [adevinta/zoe] 36 documents found !Lakukan kueri pencarian:
❯ doks search ' aws kafka ' | jq ' . 'Hasilnya ada di JSON dan akan terlihat seperti berikut:
[
{
"link" : " https://github.com/adevinta/zoe/blob/master/docs/advanced/runners/lambda.md " ,
"score" : 3.4977975 ,
"matches" : {
"content" : [
" # Lambda runner nn The lambda runner triggers lambda functions to read / produce to the <B>Kafka</B> " ,
" using CloudFormation (an S3 bucket, <B>AWS</B> roles, etc.). For more details on the resources deployed " ,
" into <B>AWS</B> and registering the lambda within <B>AWS</B>. Zoe jar path needs to be set and must point to a valid zoe "
]
}
},
...
]Anda juga dapat menggunakan JTAB untuk mencetak hasil JSON sebagai tabel:
❯ doks search ' documentation search ' | jtab | less -S
┌────────────────────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬────────────┐
│ link │ matches │ score │
├────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼────────────┤
│ https://github.com/wlezzar/doks/blob/master/README.md │ content: │ 6.044318 │
│ │ - " <B>documents</B> coming from multiple sources (github, google drive, etc.) into a <B>search</B> engine (Lucene " │ │
│ │ - " - [adevinta/zoe] 36 <B>documents</B> found!n ` ` ` nn Make a < B > search < /B > query: nn ` ` ` bashn❯ doks <B>search</B> 'aws kafka' | jq " │ │
│ │ - " # DoksnnIf you have <B>documentation</B> spread all over the place (github, google drive, etc.) and you " │ │
├────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼────────────┤
│ https://github.com/adevinta/zoe/blob/master/docs/basics/consume.md │ content: │ 3.2647414 │
│ │ - " will discard the message or not.nnThis feature can be used to perform <B>searches</B> into Kafka topics. It is one " │ │
│ │ - " ` ) and parallel execution ( ` --jobs 20 ` to spin up 20 pods), we can perform expensive < B > searches < /B > " │ │
│ │ - " execution in the advanced section of the < B > documentation < /B > . nn Filters are enabled with the ` --filter ` option " │ │
└────────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴────────────┘Doks juga memiliki mode UI untuk pembenci CLI;)
❯ doks serve
23:16:10 INFO - listening on port: 8888
Anda sekarang dapat membuka browser Anda di: http: // localhost: 8888.
Doks sedang dalam tahap awal. Bug harus diharapkan;). Jika Anda menemukan beberapa atau membutuhkan bantuan, jangan ragu untuk membuka masalah GitHub.
