mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-23 14:44:21 +02:00
Code Issues Releases Wiki Activity

Updated Usage (markdown)

Nick Sweeting
2023-01-30 23:53:45 -08:00
parent f4cd512c4b
commit 6e9701456a
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Usage.md

@@ -7,7 +7,8 @@
<img src="https://i.imgur.com/aQZZcku.png" width="20%" align="right"/>
- [CLI Usage](#CLI-Usage): Docs and examples for the ArchiveBox command line interface.
- [UI Usage](#UI-Usage): Docs and screenshots for the outputted HTML archive interface.
- [Admin UI Usage](#UI-Usage): Docs and screenshots for the outputted HTML archive interface.
- [Browser Extension Usage](#Browser-Extension-Usage): Docs and screenshots for the outputted HTML archive interface.
- [Disk Layout](#Disk-Layout): Description of the archive folder structure and contents.
**Related:**
@@ -146,6 +147,18 @@ A logged-in admin user may perform these operations on one or more snapshots:
- <kbd>Reset</kbd> Delete all type of output and redownload them. In the contrary of snapshot, this will overwrite the files.
- <kbd>Delete</kbd> Delete a snapshot entirely. This action cannot be undone.
## Browser Extension Usage
Get the official [`@tjhorner/archivebox-exporter` Browser Extension](https://github.com/tjhorner/archivebox-exporter):
- [Chrome/Edge/Other Chromium](https://chrome.google.com/webstore/detail/habonpimjphpdnmcfkaockjnffodikoj)
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/archivebox-exporter/)
<img width="452" alt="image" src="https://user-images.githubusercontent.com/511499/215699060-a0b856fa-21fb-40b5-b17b-8de8625d8adf.png">
<img width="597" alt="image" src="https://user-images.githubusercontent.com/511499/215699375-5c98c9bb-56fd-4a46-a990-e5745d46019c.png">
See https://github.com/ArchiveBox/ArchiveBox/issues/577 for more information.
## Disk Layout
The `OUTPUT_DIR` folder (usually whatever folder you run the `archivebox` command in), contains the UI HTML and archived data with the structure outlined below.