Skip to content

Commit 11bbeb7

Browse files
docs: Move config session
1 parent 0e792b2 commit 11bbeb7

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Tool to extract namespace/functions documentation from Clojure projects into indexed [datalevin](https://github.com/juji-io/datalevin) file.
44

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+
514
# CLI
615

716
## Extract and generate datalevin file
@@ -32,15 +41,6 @@ DB->>CI: Bulk-transact all datoms
3241
CI->>RE: Zip and Publish
3342
```
3443

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-
4444
# Using
4545
Go to this github [release page](https://github.com/clj-codes/docs.extractor/releases), download and unzip the `docs-db.zip` file.
4646

0 commit comments

Comments
 (0)