mirror of
https://github.com/bellingcat/auto-archiver.git
synced 2026-06-11 04:38:29 +03:00
Add a cheat sheet for configs and better folder structure for core modules
This commit is contained in:
@@ -6,3 +6,9 @@ The default (enabled) databases are the CSV Database and the Console Database.
|
||||
|
||||
```{include} autogen/database.md
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:depth: 1
|
||||
:glob:
|
||||
autogen/database/*
|
||||
```
|
||||
@@ -4,4 +4,10 @@ Enricher modules are used to add additional information to the items that have
|
||||
|
||||
|
||||
```{include} autogen/enricher.md
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:depth: 1
|
||||
:glob:
|
||||
autogen/enricher/*
|
||||
```
|
||||
@@ -8,4 +8,10 @@ Extractors that are able to extract content from a wide range of websites includ
|
||||
3. WACZ Extractor: runs a web browser to 'browse' the URL and save a copy of the page in WACZ format.
|
||||
|
||||
```{include} autogen/extractor.md
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:depth: 1
|
||||
:glob:
|
||||
autogen/extractor/*
|
||||
```
|
||||
@@ -5,4 +5,10 @@ Feeder modules are used to feed URLs into the `auto-archiver` for processing. Fe
|
||||
The default feeder is the command line feeder, which allows you to input URLs directly into the `auto-archiver` from the command line.
|
||||
|
||||
```{include} autogen/feeder.md
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:depth: 1
|
||||
:glob:
|
||||
autogen/feeder/*
|
||||
```
|
||||
@@ -3,4 +3,10 @@
|
||||
Formatter modules are used to format the data extracted from a URL into a specific format. Currently the most widely-used formatter is the HTML formatter, which formats the data into an easily viewable HTML page.
|
||||
|
||||
```{include} autogen/formatter.md
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:depth: 1
|
||||
:glob:
|
||||
autogen/formatter/*
|
||||
```
|
||||
Reference in New Issue
Block a user