archival-website
A template repo for making archival websites
What do you need to install on your computer to use this repo?
- Git: https://git-scm.com
This is the version control system we'll use to edit the website. You'll need it locally - you can see if you already have it by opening a terminal and running git --version
You'll need version 2.5
at least to run archival. You can check your version by running ruby --version
.
- Bundler: https://bundler.io
Once you have ruby
, you can run gem install bundler
to get this.
How to build a website with this repo
- Click the "Use this template" button at the top of this repo in github:
- Clone the resulting repo using
git clone <your-repo-url>
-
Run
bundle install
inside the local repository -
Run
rake run
inside the local repository -
Open
dist/index.html
in a browser window -
Edit the files in this repo, and see your website update in real time
How to deploy a website from a copy of this repo using netlify
-
Set up a new site in netlify
-
Connect your site to your copy of this repository
-
Add
bin/archival build
to the build steps for the repo -
Configure netlify's DNS to use your domain name
More questions?
Head to https://archival.dev for more documentation and help.