https://github.com/inadeqtfuturs/garden

🌱 a place to think about digital gardening
https://github.com/inadeqtfuturs/garden

digital-garden digital-gardening garden mdx nextjs

Last synced: 2 months ago
JSON representation

🌱 a place to think about digital gardening

• Host: GitHub
• URL: https://github.com/inadeqtfuturs/garden
• Owner: inadeqtfuturs
• Created: 2020-08-29T22:35:46.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T00:50:34.000Z (7 months ago)
• Last Synced: 2024-10-24T07:57:53.849Z (7 months ago)
• Topics: digital-garden, digital-gardening, garden, mdx, nextjs
• Language: JavaScript
• Homepage: https://digital-garden.dev
• Size: 1.12 MB
• Stars: 28
• Watchers: 1
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🌱 digital garden

![version](https://img.shields.io/badge/dynamic/json?color=blue&label=version&query=version&url=https%3A%2F%2Fraw.githubusercontent.com%2Finadeqtfuturs%2Fgarden%2Fmain%2Fpackage.json)

![CI](https://github.com/inadeqtfuturs/garden/workflows/CI/badge.svg)

an opinionated, batteries included boilerplate for md/x authoring with next.js.

checkout the [documentation](DOCUMENTATION.md) to get started.

## tech

- nextjs

- md/mdx authoring using [`next-mdx-relations`](https://github.com/inadeqtfuturs/next-mdx-relations)

- theme-ui

- styled-components

- jest/github actions (ci/cd)

- lint/prettier

## run or deploy

fork or clone

```bash

yarn

yarn dev

```

## storybook

```bash 

nvm use

yarn stories

```

## test

```bash

yarn test

```

deploy with vercel or netlify

## todo

- [x] documentation

- [x] dark/light theme

- [x] search

- [x] syntax highlighting

- [x] storybook

- [ ] multiple content directories

- [ ] specify layout through frontmatter

- [ ] roam style backlinks

- [ ] link preview

- [ ] last updated

- [ ] pagination

- [ ] images/image optimization

- [ ] cli -- allows for markdown parity