mirror of
https://github.com/ArchiveBox/ArchiveBox.git
synced 2026-06-22 11:31:05 -04:00
Nick Sweeting
46 lines
2.6 KiB
Markdown
46 lines
2.6 KiB
Markdown
# ArchiveBox Documentation
|
|
|
|
<div align="center">
|
|
|
|
<img src="https://archivebox.io/icon.png" width="80px"/>
|
|
|
|
</div>
|
|
|
|
**📖 Use the sidebar on the right to browse documentation topics ➡️**
|
|
|
|
<i>(Expand the `Pages` section to 🔍 Search for a specific term)</i>
|
|
|
|
<br/>
|
|
|
|
**📚 If you need help or have a question, you can:**
|
|
- 💬 Chat with us on our [Public Zulip Server](https://zulip.archivebox.io)
|
|
- 🐞 Open an [issue or feature request](https://github.com/ArchiveBox/ArchiveBox/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) in our bug tracker
|
|
- 💠 Reach out to me on Twitter [@ArchiveBoxApp](https://twitter.com/ArchiveBoxApp) or [@theSquashSH](https://twitter.com/theSquashSH)
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
|
|
<img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/3b6a2a9c-00d5-4702-beba-13be24eb50a2" width="30%" alt="CLI Screenshot" align="top"/>
|
|
<img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/d97bf733-4fef-4600-a3b7-c806f3212af7" width="30%" alt="Desktop index screenshot" align="top"/>
|
|
<img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/4f4517e9-a1c1-4809-91ba-cc36e91add3c" width="30%" alt="Desktop details page Screenshot"/><br/>
|
|
|
|
<a href="https://github.com/ArchiveBox/ArchiveBox">Readme</a> | <a href="https://archive.sweeting.me/">Demo</a> | <a href="https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart">Quickstart</a> | <a href="https://github.com/ArchiveBox/ArchiveBox/wiki/Usage">Usage</a> | <a href="https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community">Community</a>
|
|
|
|
<br/>
|
|
<hr/>
|
|
|
|
**🏛️ [Need professional support? Hire Us](https://docs.sweeting.me/s/archivebox-consulting-services) 💬**
|
|
|
|
<br/>
|
|
|
|
**✨ Or donate to support open-source development ✨**
|
|
|
|
[](https://hcb.hackclub.com/donations/start/archivebox) [](https://github.com/sponsors/pirate) <a href="https://archivebox-shop.fourthwall.com/"><img src="https://img.shields.io/badge/Buy-Merch-%23903851.svg"/></a>
|
|
|
|
<br/>
|
|
<sup>ArchiveBox operates as a US 501(c)(3) nonprofit FSP, <a href="https://hcb.hackclub.com/donations/start/archivebox">donations</a> are tax-deductible.<br/>(fiscally sponsored by <a href="https://hackclub.com/hcb?ref=donation">HCB</a> <code>EIN: 81-2908499</code>)</sup><br/>
|
|
<br/>
|
|
<sub>The name ArchiveBox™️ is trademarked in the US and you can find the <a href="https://www.stickermule.com/studio/brand-kits/06f665c3-5b24-4da7-98b3-61d68d3996a0">ArchiveBox brand kit</a> here.</sub>
|
|
</div>
|