Categorygithub.com/go-shiori/warc
modulepackage
0.0.0-20200621032813-359908319d1d
Repository: https://github.com/go-shiori/warc.git
Documentation: pkg.go.dev

# README

WARC

GoDoc Go Report Card

This project is now archived. If you want to archive, consider checking out obelisk. It has better output format (plain HTML) and IMHO better written than this.

WARC is a Go package that archive a web page and its resources into a single bolt database file. Developed as part of Shiori bookmarks manager.

It still in development phase but should be stable enough to use. The bolt database that used by this project is also stable both in API and file format. Unfortunately, right now WARC will disable Javascript when archiving a page so it still doesn't not work in SPA site like Twitter or Reddit.

Installation

To install this package, just run go get :

go get -u -v github.com/go-shiori/warc

Licenses

WARC is distributed under MIT license, which means you can use and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request.

# Packages

No description provided by the author

# Functions

NewArchive creates new archive based on submitted request, then save it to specified path.
Open opens the archive from specified path.

# Structs

ArchivalRequest is request for archiving a web page, either from URL or from an io.Reader.
Archive is the storage for archiving the web page.