Giter Site home page Giter Site logo

riencoertjens / digital-garden Goto Github PK

View Code? Open in Web Editor NEW

This project forked from johno/digital-garden

0.0 0.0 0.0 1.29 MB

๐ŸŒป[WIP] Gatsby Theme to build your own digital garden ๐ŸŒป๐Ÿฅ€๐ŸŒธ

HCL 3.79% JavaScript 96.21%

digital-garden's Introduction

๐ŸŒป [WIP] Digital Garden

Digital Garden is a content-first project meant to make it easier to write and curate content on the web. This is a project I've built for myself but hope it can be useful for other folks looking to create their own gardens that leverage the open web. You can use components in your content seamlessly using MDX which is rad for writing.

Motivation

I was inspired by numerous posts that struck a chord. At the time of writing this I had roughly 100 WIP blog posts and essays that were sitting, hidden in a local directory: ~nt.

With a nice digital garden, content can be fun again. With MDX you can now write dynamic and immersive content that can show rather than tell. I've found myself writing a lot more, and want to make it easy as hell to share that content with the community. With a digital garden I can share thoughts with folks without having to copy pasta the material to a GitHub Gist.

Installation

Install the libraries that are needed:

yarn add gatsby gatsby-theme-digital-garden react react-dom

Usage

Create a gatsby-config.js that uses the gatsby-theme-digital-garden theme:

// gatsby-config.js
module.exports = {
  __experimentalThemes: [
    'gatsby-theme-digital-garden'
  ]
}

Project structure

site
โ”œโ”€โ”€ gatsby-config.js
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ pages
โ”‚   โ””โ”€โ”€ index.md
โ”‚   โ””โ”€โ”€ contact.md
โ”œโ”€โ”€ posts
โ”‚   โ””โ”€โ”€ my-first-post.md
โ””โ”€โ”€ wiki
    โ”œโ”€โ”€ music
    โ”‚   โ””โ”€โ”€ list.md
    โ””โ”€โ”€ thoughts
        โ”œโ”€โ”€ thoughts-1.md
        โ””โ”€โ”€ thoughts-2.md

Ordering your content

โš ๏ธ Not yet implemented

Only the journal feature uses chronological order by default since it's meant to be a long running diary of ideas. The posts and wiki categories default to alphabetical but allow for you to set a priority. The priority key is used to sort. The higher priority number wins.

---
title: My wiki page
priority: 9999
---

๐Ÿ›ฐ Future

This project is nowhere close to completed. There are numerous things on the horizon like:

  • Content ordering
  • Wiki index page
  • Typography theming
  • Layout theming
  • Custom colors
  • Projects section (portfolio)
  • Post archive

Built with

Related

These following posts served as an inspiration to start this project.

digital-garden's People

Contributors

adrw avatar christopherbiscardi avatar johno avatar jxnblk avatar renovate-bot avatar riencoertjens avatar tayiorbeii avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.