This is a sample readme file

If your repo contains a markdown file called README.md, it will be shown here.

The "Files" and "Patches" links above are not part of the readme -- those are shown for every repository.

General info

This project creates pages for viewing the files and patches inside of a darcs repository. It uses the Eleventy static site generator (11ty.dev) to do so.

Installation and Setup

1. Have darcs installed
2. Have nodejs installed
3. Clone this repository

   darcs clone https://repos.tuckerm.us/repos/eleventy-darcs/branches/main
   

4. Edit darcsconfig.js, changing the objects under repos to be your local repositories that you want to create a repo viewer for.

TODOs

• [x] Display the readme on the repo home page
• [x] Syntax highlighting (highlight.js?)
  • ended up using prism.js
• [ ] have an option for syntax highlighting when generated (not in user's browser)
• [ ] Turn this into an 11ty plugin so that people can add this repo viewer to their existing 11ty blog, instead of having to be its own separate website
• [ ] config option for how many recent patches to show in sidebar
• [ ] config option for how many patches to include total in rss feed
• [ ] show repo's tags somewhere
• [ ] config option for snapshotting all files at various tag points
• [ ] remember the user's side-by-side/unified diff choice
• [ ] move javascript into its own file instead of being at the bottom of _includes/main.njk