https://github.com/arxiv-vanity/arxiv-vanity

Renders papers from arXiv as responsive web pages so you don't have to squint at a PDF.
https://github.com/arxiv-vanity/arxiv-vanity

academic-publishing arxiv latex science

Last synced: about 1 hour ago
JSON representation

Renders papers from arXiv as responsive web pages so you don't have to squint at a PDF.

• Host: GitHub
• URL: https://github.com/arxiv-vanity/arxiv-vanity
• Owner: arxiv-vanity
• License: apache-2.0
• Created: 2017-08-12T14:41:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-31T22:05:10.000Z (over 1 year ago)
• Last Synced: 2024-12-14T12:03:55.959Z (7 days ago)
• Topics: academic-publishing, arxiv, latex, science
• Language: Python
• Homepage: https://www.arxiv-vanity.com
• Size: 2.13 MB
• Stars: 1,615
• Watchers: 23
• Forks: 94
• Open Issues: 75
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pdf - vanity

README

        
# arXiv Vanity

[arXiv Vanity](https://www.arxiv-vanity.com) renders papers from [arXiv](https://arxiv.org) as responsive web pages so you don't have to squint at a PDF.

It turns this sort of thing:



Into this:



This is the web interface for viewing papers. The actual LaTeX to HTML conversion (the interesting bit) is done by [Engrafo](https://github.com/arxiv-vanity/engrafo).

## Running in development

Install Docker for Mac or Windows.

Do the initial database migration and set up a user:

    $ script/manage migrate

    $ script/manage createsuperuser

Pull the Engrafo Docker image, which is needed for rendering papers:

    $ docker pull arxivvanity/engrafo

Then to run the app:

    $ docker-compose up --build

Your app is now available at [http://localhost:8000](http://localhost:8000). The admin interface is at [http://localhost:8000/admin/](http://localhost:8000/admin/).

You can scrape the latest papers from arXiv by running:

    $ script/manage scrape_papers

It'll probably fetch quite a lot, so hit `ctrl-C` when you've got enough.

## Running tests

    $ script/test

## Using a development version of Engrafo

[Engrafo](https://github.com/arxiv-vanity/engrafo) is the LaTeX to HTML converter. If you are working on Engrafo, you might want to use the version you are working on locally.

To do that, run `script/docker-build` in your local Engrafo directory. This will create an image called `engrafo-dev`.

Then, in the arXiv Vanity directory (the same one this readme is in), create a file called `.env` to tell arXiv Vanity to use that image to render papers:

```

ENGRAFO_IMAGE=engrafo-dev

```

## VS Code development environment

This project is configured with a dev container to get completions, etc inside VS Code. When VS Code opens, click "reopen in container" in the popup and it'll run the development environment inside the same container used by `docker-compose`.

## Sponsors

Thanks to our generous sponsors for supporting the development of arXiv Vanity! [Sponsor us to get your logo here.](https://www.patreon.com/arxivvanity)

[](https://www.yld.io/)