This GitHub repository stores the source code for the documentation for The Revolutionary City: A Portal for the Nation's Founding (Rev City). Though its primary audience is the staff who contribute material to Rev City, edits for the documentation are welcome.
The documentation pages are written in Jekyll and use the Just the Docs theme. Pages are written in Markdown. The site is published via GitHub actions.
For help using Markdown, please take this Markdown tutorial and see this cheatsheet.
Anyone can contribute to improving the documentation.
Rev City administrators should edit the Markdown files directly.
For all others, please do one of the following:
- Open an issue and describe the changes you would like to see;
- Make a pull request and propose changes yourself.
You can test and run the site locally through the following workflow.
- Install Ruby and Jekyll.
- In your terminal, navigate to where you want to put the site, then clone this repo and move into the directory the process creates:
git clone https://github.com/AmericanPhilosophicalSociety/RevCityDocs.git
cd RevCityDocs
- Install the Jekyll dependencies:
bundle install
- Run the site locally:
bundle exec jekyll serve
- Navigate to http://localhost:4000/ to preview the site.