Releases: NotCraft/ArxivFeed
Releases · NotCraft/ArxivFeed
ArxivFeed v0.1.4
ArxivFeed v0.1.3
- fix order
ArxivFeed v0.1.2
- fix copy static files
ArxivFeed v0.1.1
- fix time limit
ArxivFeed v0.1.0
NotCraft::ArxivFeed
An Arxiv reader running entirely from your GitHub repo.
- Free hosting on GitHub Pages. No ads. No third party tracking.
- No need for backend. Content updates via GitHub Actions.
- Customizable layouts and styles via templating and theming API. Just bring your HTML and CSS.
- Free and open source. No third-party tracking.
How to use it?
Github Pages
-
Use the ArxivFeed-Template generate your own repository.
-
In the repository root, open
config.tomlfile, click the "Pencil (Edit this file)" button to edit. -
Remove
#to uncommend thecacheUrlproperty, replace<github_username>with your GitHub username, and
replace<repo>with your GitHub repo name. -
In the sources, update the items to the sources you want to follow. The final content of the file should look similar
to this:site_title = "ArxivDaily" cache_max_days = 7 # statics_dir = "statics" ## Optional: default is "statics" # templates_dir = "includes" ## Optional: default is "includes" # cache_url = "https://GITHUB_USERNAME.github.io/REPO_NAME/cache.json" [[sources]] limit = 1 # Num Limit category = "cs.CL" # Subject Category title = "Computation and Language" # Subject Title # [scripts] # highlight = "scripts/highlight.rhai"
-
Scroll to the bottom of the page, click "Commit changes" button.
-
Once the rebuild finishes, your feed will be available at
https://<github_username>.github.io/<repo>
Localhost
- Clone the ArxivFeed-Template repository.
- Edit
config.tomlfile. - Run
arxivfeed