https://github.com/hyphacoop/digitalgarden

A public notebook / digital garden for The Bentway’s Digital and/as Public Space Micro-Residency
https://github.com/hyphacoop/digitalgarden

Last synced: 1 day ago
JSON representation

A public notebook / digital garden for The Bentway’s Digital and/as Public Space Micro-Residency

• Host: GitHub
• URL: https://github.com/hyphacoop/digitalgarden
• Owner: hyphacoop
• License: gpl-3.0
• Created: 2021-03-01T18:49:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-06-28T14:27:58.000Z (over 3 years ago)
• Last Synced: 2024-10-29T09:22:11.812Z (11 days ago)
• Language: SCSS
• Homepage: https://digitalgarden.hypha.coop
• Size: 11.7 MB
• Stars: 34
• Watchers: 4
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - hyphacoop/digitalgarden - A public notebook / digital garden for The Bentway’s Digital and/as Public Space Micro-Residency (others)

README

        
# Digital Garden

[![HTMLProofer](https://github.com/hyphacoop/digitalgarden/actions/workflows/main.yml/badge.svg)](https://github.com/hyphacoop/digitalgarden/actions/workflows/main.yml)

[![GitHub Pages Deploy](https://github.com/hyphacoop/digitalgarden/actions/workflows/deploy.yml/badge.svg)](https://github.com/hyphacoop/digitalgarden/actions/workflows/deploy.yml)

A public notebook / digital garden for The Bentway’s [Digital and/as Public Space Micro-Residency](https://www.thebentway.ca/stories/the-bentway-announces-eight-micro-residencies-as-part-of-the-digital-and-as-public-space-initiative/).

[Visit the garden](https://digitalgarden.hypha.coop)

## Adding and connecting notes

- [Notes](./_notes) in the Digital Garden are stored in the `./_notes` folder as markdown files (`*.md`) files.

- Connecting notes is done through a double-bracket notation: `[[text to link]]`. View the [The Statement of Intent](./_notes/statement-of-intent.md) 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](https://jekyllrb.com/), a static website generator written in Ruby

    + Initial template is based on the [Digital garden Jekyll template](https://github.com/maximevaillancourt/digital-garden-jekyll-template) by Maxime Vaillancourt

- [Tachyons](https://tachyons.io/), a functional CSS library that allows us to quickly grow the garden

- [D3.js](https://d3js.org/), a JavaScript library for visualizing data

    + Initial knowledge graph implementation from the [Digital garden Jekyll template](https://github.com/maximevaillancourt/digital-garden-jekyll-template)

- [GitHub Actions](https://github.com/hyphacoop/digitalgarden/actions) for testing, building, and deploying the site.

    + [GitHub Actions for GitHub Pages](https://github.com/peaceiris/actions-gh-pages) is used to deploy the site to the [`gh-pages`](https://github.com/hyphacoop/digitalgarden/tree/gh-pages) branch

- [Jekyll Feed plugin](https://github.com/hyphacoop/jekyll-feed), a plugin for Jekyll to generate an RSS feed

## Development

1. Clone repository: `git clone [email protected]:hyphacoop/digitalgarden.git`

2. Install Bundler gem: `gem install bundler`

3. Install dependencies: `bundle install`

4. Run locally: `bundle exec jekyll serve` or `rake watch`

5. Visit your `localhost` on port `4000`: 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](https://github.com/hyphacoop/digitalgarden/blob/main/LICENSE).