Statically generated digital garden for the KCL DIgital Humanities department.
Based on https://github.com/hyphacoop/digitalgarden
|
|
||
|---|---|---|
| _includes | ||
| _layouts | ||
| _notes | ||
| _plugins | ||
| _sass | ||
| assets | ||
| _config.yml | ||
| .drone.yml | ||
| .gitignore | ||
| 404.html | ||
| colophon.md | ||
| docker-compose.dev.yml | ||
| docker-compose.yml | ||
| docker-entrypoint.sh | ||
| Dockerfile | ||
| Dockerfile.dev | ||
| favicon.ico | ||
| Gemfile | ||
| Gemfile.lock | ||
| graph.md | ||
| index.md | ||
| LICENSE | ||
| nginx.conf | ||
| Rakefile | ||
| README.md | ||
Digital Garden
A public notebook / digital garden for King's College London's digital humanities department.
Based on Hypha's digital garden for The Bentway's Digital and/as Public Space Micro-residency.
Adding and connecting notes
- Notes in the Digital Garden are stored in the
./_notesfolder as markdown files (*.md) files. - Connecting notes is done through a double-bracket notation:
[[text to link]]. View the The Statement of Intent note as an example. - A link without a corresponding markdown file will be highlighted and left unlinked until a file is created.
Technologies used
- Jekyll, a static website generator written in Ruby
- Initial template is based on the Digital garden Jekyll template by Maxime Vaillancourt
- Tachyons, a functional CSS library that allows us to quickly grow the garden
- D3.js, a JavaScript library for visualizing data
- Initial knowledge graph implementation from the Digital garden Jekyll template
- Jekyll Feed plugin, a plugin for Jekyll to generate an RSS feed
- Jekyll serve by Brett Fisher
Development
Using docker
- Run
docker compose -f docker-compose.dev.yml up - Visit your
localhoston port4000: http://localhost:4000 or http://0.0.0.0:4000
Using jekyll
- Clone repository:
git clone ssh://git@git.autonomic.zone:2222/autonomic-cooperative/kcl-digital-humanities-garden.git - Install ruby's command line tools with your package manager (e.g.
brew install ruby) - Install Bundler gem:
gem install bundler - Install dependencies:
bundle install - Run locally:
bundle exec jekyll serveorrake watch - Visit your
localhoston port4000: http://localhost:4000 or http://127.0.0.1:4000
License
Digital Garden content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
All code at github.com/hyphacoop/digitalgarden/ is licensed under a GNU General Public License v3.0, the text of which is included in the repository here.