Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deejungx/knowledge-garden
https://github.com/deejungx/knowledge-garden
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/deejungx/knowledge-garden
- Owner: deejungx
- License: bsd-3-clause
- Created: 2023-01-19T16:05:33.000Z (about 2 years ago)
- Default Branch: release
- Last Pushed: 2023-01-19T16:07:47.000Z (about 2 years ago)
- Last Synced: 2024-11-03T06:41:37.257Z (3 months ago)
- Language: JavaScript
- Size: 2.02 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Gatsby Starter Obsidian Garden
A Gatsby starter template to publish [Obsidian](https://obsidian.md/) vault for free, created by [@juxtdesigncc](https:/juxtdesign.cc/?utm_source=obsidian-garden)
## 🚀 Quick Start
[](https://www.gatsbyjs.com/dashboard/deploynow?url=https://github.com/juxtdesigncc/gatsby-starter-obsidian-garden)
[](https://app.netlify.com/start/deploy?repository=https://github.com/juxtdesigncc/gatsby-starter-obsidian-garden)
## 💎 Key Features
Obsidian currently offers Publish services ($20/month) with advance features. This starter is a free alternative for Obsidian users who want to publish their digital garden as a website. Obsidian can also serve as an on-device CMS to manage your content. (Cross-platform synchronization is also possible via Obsidian Sync / [Git](https://desktopofsamuel.com/how-to-sync-obsidian-vault-for-free-using-git/?utm_source=github&utm_medium=readme&utm_id=starter-obsidian))
- Publish your [Obsidian](https://obsidian.md/) knowledge base as a website for free using Gatsby
- Support same YAML (e.g. tags, publish) as Obsidian
- Display notes' maturity, customizable stages (This template used [Maggie Appleton's metaphor](https://maggieappleton.com/garden-history) - "Seedling", "Budding", "Evergreen" as an example to illustrate notes' maturity)
- Better SEO than Obsidian Publish (Using `react-helmet` for basic SEO setup)
---
## 🚀 Getting Started
### 1. Create a Gatsby site.
Clone this template and navigate into the folder
```node
# Create a gatsby site with npx
npx gatsby new project-name https://github.com/juxtdesigncc/gatsby-starter-obsidian-garden
cd project-name
# or
git clone https://github.com/juxtdesigncc/gatsby-starter-obsidian-garden project-name
cd project-name
```
### 2. Install dependencies.
Install dependencies using yarn or npm
```node
# Using yarn
yarn install
# Using npm
npm install
```
### 3. Run development server
Let's run the dev server to know it's working before updating any content or code.
```
gatsby develop
```
Your site is now running at http://localhost:8000!
### 4. Open the code and start customizing
Start customizing:
- `/content/vault` stored all demo content. You can also use Obsidian to open the folder as a vault.
- `/config.js` to customise the site metadata, top and footer navigation
- `/gatsby` to customise all page generation in `gatsby-node.js`
```
code .
```
---
## 💻 Setup
**Read before you use your own Obsidian vault or create a new one**
Whether you wish to use your existing Obsidian vault or start a new vault, the following Obsidian preferences has to be set up correctly. Starting a new vault is highly recommended as these options are not on by default. All existing notes using the `[[Wikilinks]]` will need to update manually. Here're a list of preferences:
- Settings - Files & Links: Use [[Wikilinks]] option should be OFF. It will change the link format from `[[Wikilinks]]` to `[MarkdownLink]`.
- Settings - Default location for new attachments: Should be set as 'In a folder specificed below' and create a folder named `media`, remember to update the config in `gatsby-source-filesystem` in `gatsby-config.js` if the media folder has changed.
- By default, all notes will be published , but add frontmatter `publish: false` to hide a note.
Current example vault in `/content/vault` has already implemented all the aforementioned preference settings
## 🎯 Roadmap
- [ ] Better SEO
- [ ] Wiki Link
- [ ] Obsidian-like node graphs
## 💪🏻 Support
Thank you for trying this out! I'm still constantly shipping new updates to this project. Stay tuned for more news!
You can support this project by:
- Raise issues on [Github](https://github.com/juxtdesigncc/gatsby-starter-obsidian-garden/issues) if you catch any bugs
- Submit a [PR](https://github.com/juxtdesigncc/gatsby-starter-obsidian-garden/pulls) if you discovered a solution
- Share this project on Twitter and tag [me](https://twitter.com/juxtdesigncc)!
- Give me a star on [Github](https://github.com/juxtdesigncc/gatsby-starter-obsidian-garden/)