|
2 | 2 |
|
3 | 3 | Tool to extract namespace/functions documentation from Clojure projects into indexed [datalevin](https://github.com/juji-io/datalevin) file. |
4 | 4 |
|
| 5 | +# Config `resources/config.edn` |
| 6 | +This file has two main functions: |
| 7 | +- `:db` key is defined where the datalevin files will be placed. |
| 8 | +- `:deps` key is defined which libraries will be downloaded, parsed and indexed in the database |
| 9 | + - This configuration is made using the same [clojure.tools.deps's git coordinates](https://clojure.org/reference/deps_edn#deps_git) with some extra keys: |
| 10 | + - `:project/group` use to overide the project group, currently extracted from the lib ORG |
| 11 | + - `:deps/manifest :deps` since we use tools.deps we need to set this on pure lein projects to force the download of the lib. |
| 12 | + - `:project/source-paths` if a lein lib uses `:source-paths`, like reitit, we need to add this information here to indicate to clj-kondo where are the files to analyze. |
| 13 | + |
5 | 14 | # CLI |
6 | 15 |
|
7 | 16 | ## Extract and generate datalevin file |
@@ -32,15 +41,6 @@ DB->>CI: Bulk-transact all datoms |
32 | 41 | CI->>RE: Zip and Publish |
33 | 42 | ``` |
34 | 43 |
|
35 | | -# Config `resources/config.edn` |
36 | | -This file has two main functions: |
37 | | -- `:db` key is defined where the datalevin files will be placed. |
38 | | -- `:deps` key is defined which libraries will be downloaded, parsed and indexed in the database |
39 | | - - This configuration is made using the same [clojure.tools.deps's git coordinates](https://clojure.org/reference/deps_edn#deps_git) with some extra keys: |
40 | | - - `:project/group` use to overide the project group, currently extracted from the lib ORG |
41 | | - - `:deps/manifest :deps` since we use tools.deps we need to set this on pure lein projects to force the download of the lib. |
42 | | - - `:project/source-paths` if a lein lib uses `:source-paths`, like reitit, we need to add this information here to indicate to clj-kondo where are the files to analyze. |
43 | | - |
44 | 44 | # Using |
45 | 45 | Go to this github [release page](https://github.com/clj-codes/docs.extractor/releases), download and unzip the `docs-db.zip` file. |
46 | 46 |
|
|
0 commit comments