Skip to content

Commit

Permalink
More README updates.
Browse files Browse the repository at this point in the history
- Clone recursively instructions to simplify things.
- Add a section on limitations of the backup.
  • Loading branch information
thedeadparrot committed Jun 3, 2023
1 parent 4a0d7d0 commit 2735006
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This is not currently designed to be usable for anyone not comfortable with the
This is for if you don't want to futz around with getting GitHub actions to work or using GitHub in particular.

#### Scraping AO3
1. Run `git clone https://github.com/thedeadparrot/ao3backup.git`
1. Run `git clone --recursive https://github.com/thedeadparrot/ao3backup.git`
2. Set up a python virtualenv.
3. Run `pip install -r ao3scrape/requirements.txt`
4. Modify `ao3scrape/settings.py` to set `AO3_USER` to your own AO3 username.
Expand All @@ -27,7 +27,6 @@ This is for if you don't want to futz around with getting GitHub actions to work

#### Building the static site
1. Install [Hugo](https://gohugo.io/).
2. Run `git submodule add hermit`. This will pull in the theme.
3. Modify `backup/config.toml` with your own name and links and other configuration you might be interested in.
4. Run `hugo` from within the `backup` directory.
5. Your static site should now be in `backup/public`, which can then be hosted wherever you wish.
Expand All @@ -45,3 +44,14 @@ These instructions assume a familiarity with both GitHub and git.
6. From your fork, run the action `Scrape AO3 and attempt to commit`, inserting the username when prompted.
7. Once that action has run (mine takes about 30 minutes), check your pull requests for the new markdown files and merge if they look good.
8. Run `Deploy Hugo site to Pages` to build and deploy your site.

# Limitations

Since I built this for me, I have not addressed every possible use case. There are a few that I know for a fact we don't handle.

* This doesn't scrape anything that is private or ao3-locked. It is welcomed and encouraged to make your own markdown files for those works if you would like to archive them.
* Series ordering for the most part doesn't work. This is mostly the fault of Hugo.
* Also the fault of Hugo is that [it doesn't handle tags/fandoms/pairings that end in a period](https://github.com/gohugoio/hugo/issues/10475). I chop them off the ends, so that's why your tags might look weird.
* Since this doesn't have any underlying understanding of synonymous tags, some of the tag wrangling magic of AO3 is gone. How it shows up on your work is how it shows up in your generated site.
* There is no single-chapter view for works.
* I'm sure I'm missing a bunch of other caveats. Sorry.

0 comments on commit 2735006

Please sign in to comment.