diff --git a/docs/cli.md b/docs/cli.md
index 6ff1e8fdfe..3f27c67b5d 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -4,10 +4,10 @@
_Global utilities_
-- [-h/--help/help](#help-flag)
-- [--version](#version-flag)
-- [minetrc config files](#minetrc)
-- [minet environment variables](#envvars)
+- [-h/--help/help](#h--help)
+- [--version](#version)
+- [minetrc config files](#minetrc-config-files)
+- [minet environment variables](#minet-environment-variables)
_Generic commands_
@@ -26,43 +26,43 @@ _Generic commands_
_Platform-related commands_
- [buzzsumo (bz)](#buzzsumo)
- - [limit](#buzzsumo-limit)
- - [domain-summary](#buzzsumo-domain-summary)
- - [domain](#buzzsumo-domain)
- - [exact-url](#buzzsumo-exact-url)
+ - [limit](#limit)
+ - [domain-summary](#domain-summary)
+ - [domain](#domain)
+ - [exact-url](#exact-url)
- [crowdtangle (ct)](#crowdtangle)
- [leaderboard](#leaderboard)
- [lists](#lists)
- [posts-by-id](#posts-by-id)
- [posts](#posts)
- - [search](#ct-search)
+ - [search](#search)
- [summary](#summary)
- [facebook (fb)](#facebook)
- - [comments](#facebook-comments)
- - [post](#facebook-post)
- - [posts](#facebook-posts)
- - [post-authors](#facebook-post-authors)
- - [url-likes](#facebook-url-likes)
+ - [comments](#comments)
+ - [post](#post)
+ - [posts](#posts-1)
+ - [post-authors](#post-authors)
+ - [url-likes](#url-likes)
- [google](#google)
- - [sheets](#google-sheets)
+ - [sheets](#sheets)
- [hyphe](#hyphe)
- - [crawl](#hyphe-crawl)
- - [declare](#hyphe-declare)
- - [destroy](#hyphe-destroy)
- - [dump](#hyphe-dump)
- - [reset](#hyphe-reset)
- - [tag](#hyphe-tag)
+ - [crawl](#crawl)
+ - [declare](#declare)
+ - [destroy](#destroy)
+ - [dump](#dump)
+ - [reset](#reset)
+ - [tag](#tag)
- [instagram (insta)](#instagram)
- - [comments](#insta-comments)
+ - [comments](#comments-1)
- [hashtag](#hashtag)
- - [post-infos](#insta-post-infos)
+ - [post-infos](#post-infos)
- [user-followers](#user-followers)
- [user-following](#user-following)
- [user-infos](#user-infos)
- [user-posts](#user-posts)
- [mediacloud (mc)](#mediacloud)
- - [medias](#mc-medias)
- - [search](#mc-search)
+ - [medias](#medias)
+ - [search](#search-1)
- [topic](#topic)
- [stories](#stories)
- [telegram (tl)](#telegram)
@@ -91,11 +91,11 @@ _Platform-related commands_
- [captions](#captions)
- [channel-videos](#channel-videos)
- [channels](#channels)
- - [comments](#youtube-comments)
- - [search](#youtube-search)
+ - [comments](#comments-2)
+ - [search](#search-2)
- [videos](#videos)
--h/--help
+## -h/--help
If you need help about a command, don't hesitate to use the `-h/--help` flag or the `help` command:
@@ -107,7 +107,7 @@ minet ct posts --help
minet help ct posts
```
-
+## --version
To check the installed version of `minet`, you can use the `--version` flag:
@@ -116,7 +116,7 @@ minet --version
>>> minet x.x.x
```
-minetrc config files
+## minetrc config files
Minet supports configuration files so you can skip some tedious command line arguments that you would need to provide each time you call `minet` otherwise (such as `--token` for crowdtangle commands).
@@ -152,11 +152,11 @@ youtube:
key: "MY_YT_API_KEY" # Used as --key for `minet yt` commands
```
-minet environment variables
+## minet environment variables
Alternatively you can also set some arguments using environment variables whose name starts with `MINET_` and followed by the proper key.
-To build the name of the variable, first check what can be configured in a minet [rcfile](#minetrc) and build your variable name by joining its path using an underscore:
+To build the name of the variable, first check what can be configured in a minet [rcfile](#minetrc-config-files) and build your variable name by joining its path using an underscore:
For instance, to override `facebook.cookie`, the variable will be `MINET_FACEBOOK_COOKIE`.
@@ -1810,7 +1810,7 @@ Subcommands:
Subcommand to use.
```
-limit
+### limit
```
Usage: minet buzzsumo limit [-h] [-t TOKEN] [--rcfile RCFILE] [--silent]
@@ -1853,7 +1853,7 @@ Examples:
$ minet bz limit --token YOUR_TOKEN
```
-domain-summary
+### domain-summary
```
Usage: minet buzzsumo domain-summary [-h] [-t TOKEN] [--rcfile RCFILE]
@@ -1957,7 +1957,7 @@ how to use the command with a CSV file?
$ minet buzzsumo domain-summary "value1,value2" --explode ","
```
-domain
+### domain
```
Usage: minet buzzsumo domain [-h] [-t TOKEN] [--rcfile RCFILE] [--silent]
@@ -2059,7 +2059,7 @@ how to use the command with a CSV file?
$ minet buzzsumo domain "value1,value2" --explode ","
```
-exact-url
+### exact-url
```
Usage: minet buzzsumo exact-url [-h] [-t TOKEN] [--rcfile RCFILE] [--silent]
@@ -2505,7 +2505,7 @@ To know the different list ids associated with your dashboard:
$ minet ct lists --token YOUR_TOKEN
```
-search
+### search
```
Usage: minet crowdtangle search [-h] [--rate-limit RATE_LIMIT] [--rcfile RCFILE]
@@ -2711,7 +2711,7 @@ how to use the command with a CSV file?
```
Usage: minet facebook [-h]
- {comments,post-authors,post-stats,post,posts,url-likes}
+ {comments,experimental-comments,post-authors,post-stats,post,posts,url-likes}
...
# Minet Facebook Command
@@ -2722,11 +2722,11 @@ Optional Arguments:
-h, --help show this help message and exit
Subcommands:
- {comments,post-authors,post-stats,post,posts,url-likes}
+ {comments,experimental-comments,post-authors,post-stats,post,posts,url-likes}
Subcommand to use.
```
-
+### comments
```
Usage: minet facebook comments [-h] [-c COOKIE] [--rcfile RCFILE] [--silent]
@@ -2836,7 +2836,7 @@ how to use the command with a CSV file?
$ minet facebook comments "value1,value2" --explode ","
```
-post
+### post
```
Usage: minet facebook post [-h] [-c COOKIE] [--rcfile RCFILE] [--silent]
@@ -2967,7 +2967,7 @@ how to use the command with a CSV file?
$ minet facebook post "value1,value2" --explode ","
```
-posts
+### posts
```
Usage: minet facebook posts [-h] [-c COOKIE] [--rcfile RCFILE] [--silent]
@@ -3098,7 +3098,7 @@ how to use the command with a CSV file?
$ minet facebook posts "value1,value2" --explode ","
```
-post-authors
+### post-authors
```
Usage: minet facebook post-authors [-h] [-c COOKIE] [--rcfile RCFILE] [--silent]
@@ -3196,7 +3196,7 @@ how to use the command with a CSV file?
$ minet facebook post-authors "value1,value2" --explode ","
```
-url-likes
+### url-likes
```
Usage: minet facebook url-likes [-h] [--silent]
@@ -3306,7 +3306,7 @@ Subcommands:
{sheets} Subcommand to use.
```
-sheets
+### sheets
```
Usage: minet google sheets [-h] [--silent]
@@ -3370,7 +3370,7 @@ Examples:
## Hyphe
-crawl
+### crawl
```
Usage: minet hyphe crawl [-h] [--silent]
@@ -3534,7 +3534,7 @@ storage available.
For more info, check out: https://www.sqlite.org/tempfiles.html
```
-declare
+### declare
```
Usage: minet hyphe declare [-h] [--silent]
@@ -3585,7 +3585,7 @@ Examples:
$ minet hyphe declare http://myhyphe.com/api/ target-corpus export.csv
```
-destroy
+### destroy
```
Usage: minet hyphe destroy [-h] [--silent]
@@ -3626,7 +3626,7 @@ Examples:
$ minet hyphe destroy http://myhyphe.com/api/ my-corpus
```
-dump
+### dump
```
Usage: minet hyphe dump [-h] [--silent]
@@ -3679,7 +3679,7 @@ Examples:
$ minet hyphe dump http://myhyphe.com/api/ corpus-name -O corpus
```
-reset
+### reset
```
Usage: minet hyphe reset [-h] [--silent]
@@ -3720,7 +3720,7 @@ Examples:
$ minet hyphe reset http://myhyphe.com/api/ my-corpus
```
-tag
+### tag
```
Usage: minet hyphe tag [-h] [--silent] [--refresh-per-second REFRESH_PER_SECOND]
@@ -3815,7 +3815,7 @@ Subcommands:
Subcommand to use.
```
-
+### comments
```
Usage: minet instagram comments [-h] [-c COOKIE] [--rcfile RCFILE] [--silent]
@@ -4025,7 +4025,7 @@ how to use the command with a CSV file?
$ minet instagram hashtag "value1,value2" --explode ","
```
-post-infos
+### post-infos
```
Usage: minet instagram post-infos [-h] [-c COOKIE] [--rcfile RCFILE] [--silent]
@@ -4584,7 +4584,7 @@ how to use the command with a CSV file?
## Mediacloud
-
+### medias
```
Usage: minet mediacloud medias [-h] [-t TOKEN] [--rcfile RCFILE] [--silent]
@@ -4673,7 +4673,7 @@ how to use the command with a CSV file?
$ minet mediacloud medias "value1,value2" --explode ","
```
-search
+### search
```
Usage: minet mediacloud search [-h] [-t TOKEN] [--rcfile RCFILE] [--silent]
@@ -7249,7 +7249,7 @@ how to use the command with a CSV file?
$ minet youtube channels "value1,value2" --explode ","
```
-
+### comments
```
Usage: minet youtube comments [-h] [-k KEY] [--rcfile RCFILE] [--silent]
@@ -7339,7 +7339,7 @@ how to use the command with a CSV file?
$ minet youtube comments "value1,value2" --explode ","
```
-search
+### search
```
Usage: minet youtube search [-h] [-l LIMIT] [--silent]
diff --git a/docs/cli.template.md b/docs/cli.template.md
index f5340e0a9c..1a4d48c4d2 100644
--- a/docs/cli.template.md
+++ b/docs/cli.template.md
@@ -4,10 +4,10 @@
_Global utilities_
-- [-h/--help/help](#help-flag)
-- [--version](#version-flag)
-- [minetrc config files](#minetrc)
-- [minet environment variables](#envvars)
+- [-h/--help/help](#h--help)
+- [--version](#version)
+- [minetrc config files](#minetrc-config-files)
+- [minet environment variables](#minet-environment-variables)
_Generic commands_
@@ -26,43 +26,43 @@ _Generic commands_
_Platform-related commands_
- [buzzsumo (bz)](#buzzsumo)
- - [limit](#buzzsumo-limit)
- - [domain-summary](#buzzsumo-domain-summary)
- - [domain](#buzzsumo-domain)
- - [exact-url](#buzzsumo-exact-url)
+ - [limit](#limit)
+ - [domain-summary](#domain-summary)
+ - [domain](#domain)
+ - [exact-url](#exact-url)
- [crowdtangle (ct)](#crowdtangle)
- [leaderboard](#leaderboard)
- [lists](#lists)
- [posts-by-id](#posts-by-id)
- [posts](#posts)
- - [search](#ct-search)
+ - [search](#search)
- [summary](#summary)
- [facebook (fb)](#facebook)
- - [comments](#facebook-comments)
- - [post](#facebook-post)
- - [posts](#facebook-posts)
- - [post-authors](#facebook-post-authors)
- - [url-likes](#facebook-url-likes)
+ - [comments](#comments)
+ - [post](#post)
+ - [posts](#posts-1)
+ - [post-authors](#post-authors)
+ - [url-likes](#url-likes)
- [google](#google)
- - [sheets](#google-sheets)
+ - [sheets](#sheets)
- [hyphe](#hyphe)
- - [crawl](#hyphe-crawl)
- - [declare](#hyphe-declare)
- - [destroy](#hyphe-destroy)
- - [dump](#hyphe-dump)
- - [reset](#hyphe-reset)
- - [tag](#hyphe-tag)
+ - [crawl](#crawl)
+ - [declare](#declare)
+ - [destroy](#destroy)
+ - [dump](#dump)
+ - [reset](#reset)
+ - [tag](#tag)
- [instagram (insta)](#instagram)
- - [comments](#insta-comments)
+ - [comments](#comments-1)
- [hashtag](#hashtag)
- - [post-infos](#insta-post-infos)
+ - [post-infos](#post-infos)
- [user-followers](#user-followers)
- [user-following](#user-following)
- [user-infos](#user-infos)
- [user-posts](#user-posts)
- [mediacloud (mc)](#mediacloud)
- - [medias](#mc-medias)
- - [search](#mc-search)
+ - [medias](#medias)
+ - [search](#search-1)
- [topic](#topic)
- [stories](#stories)
- [telegram (tl)](#telegram)
@@ -91,11 +91,11 @@ _Platform-related commands_
- [captions](#captions)
- [channel-videos](#channel-videos)
- [channels](#channels)
- - [comments](#youtube-comments)
- - [search](#youtube-search)
+ - [comments](#comments-2)
+ - [search](#search-2)
- [videos](#videos)
--h/--help
+## -h/--help
If you need help about a command, don't hesitate to use the `-h/--help` flag or the `help` command:
@@ -107,7 +107,7 @@ minet ct posts --help
minet help ct posts
```
-
+## --version
To check the installed version of `minet`, you can use the `--version` flag:
@@ -116,7 +116,7 @@ minet --version
>>> minet x.x.x
```
-minetrc config files
+## minetrc config files
Minet supports configuration files so you can skip some tedious command line arguments that you would need to provide each time you call `minet` otherwise (such as `--token` for crowdtangle commands).
@@ -152,11 +152,11 @@ youtube:
key: "MY_YT_API_KEY" # Used as --key for `minet yt` commands
```
-minet environment variables
+## minet environment variables
Alternatively you can also set some arguments using environment variables whose name starts with `MINET_` and followed by the proper key.
-To build the name of the variable, first check what can be configured in a minet [rcfile](#minetrc) and build your variable name by joining its path using an underscore:
+To build the name of the variable, first check what can be configured in a minet [rcfile](#minetrc-config-files) and build your variable name by joining its path using an underscore:
For instance, to override `facebook.cookie`, the variable will be `MINET_FACEBOOK_COOKIE`.
@@ -216,19 +216,19 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
<% bz %>
-limit
+### limit
<% bz/limit %>
-domain-summary
+### domain-summary
<% bz/domain-summary %>
-domain
+### domain
<% bz/domain %>
-exact-url
+### exact-url
<% bz/exact-url %>
@@ -252,7 +252,7 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
<% ct/posts %>
-search
+### search
<% ct/search %>
@@ -264,23 +264,23 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
<% fb %>
-
+### comments
<% fb/comments %>
-post
+### post
<% fb/post %>
-posts
+### posts
<% fb/posts %>
-post-authors
+### post-authors
<% fb/post-authors %>
-url-likes
+### url-likes
<% fb/url-likes %>
@@ -288,33 +288,33 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
<% google %>
-sheets
+### sheets
<% google/sheets %>
## Hyphe
-crawl
+### crawl
<% hyphe/crawl %>
-declare
+### declare
<% hyphe/declare %>
-destroy
+### destroy
<% hyphe/destroy %>
-dump
+### dump
<% hyphe/dump %>
-reset
+### reset
<% hyphe/reset %>
-tag
+### tag
<% hyphe/tag %>
@@ -322,7 +322,7 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
<% insta %>
-
+### comments
<% insta/comments %>
@@ -330,7 +330,7 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
<% insta/hashtag %>
-post-infos
+### post-infos
<% insta/post-infos %>
@@ -352,11 +352,11 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
## Mediacloud
-
+### medias
<% mc/medias %>
-search
+### search
<% mc/search %>
@@ -462,11 +462,11 @@ For more documentation about minet's scraping DSL check this [page](../cookbook/
<% yt/channels %>
-
+### comments
<% yt/comments %>
-search
+### search
<% yt/search %>
diff --git a/docs/install.md b/docs/install.md
index 248f0ca035..385bc731c3 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -2,7 +2,7 @@
## Summary
-* [macOS](macOS)
+* [macOS](#macos)
## macOS
diff --git a/docs/lib.md b/docs/lib.md
index b08f34374a..9725989ca2 100644
--- a/docs/lib.md
+++ b/docs/lib.md
@@ -1,11 +1,11 @@
# Minet Library Usage
+**NOTE**: this part of the documentation is widly out-of-date, beware!
+
## Summary
Note that if you are interested in the url cleaning, extraction and join methods exposed by minet's CLI, all of the used functions can be found in the [ural](https://github.com/medialab/ural) package instead.
-**NOTE**: this part of the documentation is mostly out-of-date, beware!
-
*Generic utilities*
* [Scraper](#scraper)