Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
- document '"mode": "jsonl"' for metadata pp
- remove 'username' and 'password' from 'instagram'
- add 'ytdl' example (#3180)
  • Loading branch information
mikf committed Nov 9, 2022
1 parent 15cd114 commit 8d543b0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3592,7 +3592,9 @@ Description
Selects how to process metadata.

* ``"json"``: write metadata using `json.dump()
<https://docs.python.org/3/library/json.html#json.dump>`_
<https://docs.python.org/3/library/json.html#json.dump>`__
* ``"jsonl"``: write metadata in `JSON Lines
<https://jsonlines.org/>`__ format
* ``"tags"``: write ``tags`` separated by newlines
* ``"custom"``: write the result of applying `metadata.content-format`_
to a file's metadata dictionary
Expand Down
13 changes: 13 additions & 0 deletions docs/gallery-dl-example.conf
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,19 @@
"text-tweets": true
},

"ytdl":
{
"#": "enable 'ytdl' extractor",
"#": "i.e. invoke ytdl on all otherwise unsupported input URLs",
"enabled": true,

"#": "use yt-dlp instead of youtube-dl",
"module": "yt_dlp",

"#": "load ytdl options from config file",
"config-file": "~/yt-dlp.conf"
},

"mastodon":
{
"#": "add 'tabletop.social' as recognized mastodon instance",
Expand Down
3 changes: 1 addition & 2 deletions docs/gallery-dl.conf
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,8 @@
},
"instagram":
{
"username": null,
"password": null,
"api": "auto",
"cookies": null,
"include": "posts",
"sleep-request": [6.0, 12.0],
"videos": true
Expand Down

0 comments on commit 8d543b0

Please sign in to comment.