Skip to content

Commit 6ba8abe

Browse files
committed
📝 update README
1 parent d94e01c commit 6ba8abe

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,29 @@ $ cocnt search ./code-counter/
4343
Totally cost 0.11359143257141113 s.
4444
```
4545

46-
Please refer to [Usage](#usage) for more usage.
46+
Please refer to <a href="#usage-toc">Usage</a> for more usage.
47+
48+
<details>
49+
<summary> <a id="usage-toc">Usage</a> </summary>
4750

4851
* [Usage](#usage)
49-
+ [search](#search)
50-
- [Search the given path directly](#search-the-given-path-directly)
51-
- [Search multiple paths at the same time](#search-multiple-paths-at-the-same-time)
52-
- [Show verbose searching information](#show-verbose-searching-information)
53-
- [Search code files for specific file suffixes](#search-code-files-for-specific-file-suffixes)
54-
- [Ignore directories or files during the search](#ignore-directories-or-files-during-the-search)
55-
+ [Specify the output path to save the search results](#specify-the-output-path-to-save-the-search-results)
56-
+ [Visualize statistical results](#visualize-statistical-results)
57-
+ [remote](#remote)
58-
- [Search and count the remote repository](#search-and-count-the-remote-repository)
59-
+ [config](#config)
60-
- [List configuration information](#list-configuration-information)
61-
- [Reset the value of the configuration variable](#reset-the-value-of-the-configuration-variable)
62-
- [Add the value of the configuration variable](#add-the-value-of-the-configuration-variable)
63-
- [Delete some configuration variable values](#delete-some-configuration-variable-values)
64-
- [Update the access tokens](#update-the-access-tokens)
65-
+ [Restore default configuration](#restore-default-configuration)
52+
+ [`search`](#search)
53+
- [Search the given path directly](#search-the-given-path-directly)
54+
- [Search multiple paths at the same time](#search-multiple-paths-at-the-same-time)
55+
- [Show verbose searching information](#show-verbose-searching-information)
56+
- [Search code files for specific file suffixes](#search-code-files-for-specific-file-suffixes)
57+
- [Ignore directories or files during the search](#ignore-directories-or-files-during-the-search)
58+
+ [Specify the output path to save the search results](#specify-the-output-path-to-save-the-search-results)
59+
+ [Visualize statistical results](#visualize-statistical-results)
60+
+ [`remote`](#remote)
61+
- [Search and count the remote repository](#search-and-count-the-remote-repository)
62+
+ [`config`](#config)
63+
- [List configuration information](#list-configuration-information)
64+
- [Reset the value of the configuration variable](#reset-the-value-of-the-configuration-variable)
65+
- [Add the value of the configuration variable](#add-the-value-of-the-configuration-variable)
66+
- [Delete some configuration variable values](#delete-some-configuration-variable-values)
67+
- [Update the access tokens](#update-the-access-tokens)
68+
+ [Restore default configuration](#restore-default-configuration)
6669

6770
## Usage
6871

@@ -88,7 +91,7 @@ optional arguments:
8891
8992
`code-counter ` supports three subcommands: [`search`](#search), [`remote`](#remote), and [`config`](#config)
9093
91-
### search
94+
### `search`
9295
9396
Search the given path and make statistics. The help information of `cocnt search` is as follows.
9497
@@ -270,7 +273,7 @@ In addition to the statistical data displayed on the terminal, the statistical c
270273

271274
![](https://cdn.jsdelivr.net/gh/innofang/jotter/source/code-counter/result.png)
272275

273-
### remote
276+
### `remote`
274277

275278
Search and count the remote `Git` repository, the help information of `cocnt remote` is as follows.
276279

@@ -334,7 +337,7 @@ $ cocnt remote https://github.com/InnoFang/code-counter.git
334337
335338
If you want to update the access token at any time, then you can refer to the [`--github-token` and `--gitee-token` flags](#update-the-access-tokens) that will be mentioned later in the introduction of [`cocnt config`](#config).
336339
337-
### config
340+
### `config`
338341
339342
Configure `code-counter`, and the help information of `cocnt config` is as follows.
340343
@@ -511,6 +514,7 @@ Use the `--restore` flag to restore the default configuration of `code-counter`.
511514
$ cocnt config --restore
512515
The default configuration will be restored. (y/n) y
513516
```
517+
</details>
514518
515519
## [License](https://github.com/InnoFang/code-counter/blob/master/LICENSE)
516520

0 commit comments

Comments
 (0)