Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blackstorm/markdownbrain
Make your 🔗🌳digital garden with 🧠MarkdownBrain.
https://github.com/blackstorm/markdownbrain
digital-garden markdown
Last synced: 27 days ago
JSON representation
Make your 🔗🌳digital garden with 🧠MarkdownBrain.
- Host: GitHub
- URL: https://github.com/blackstorm/markdownbrain
- Owner: blackstorm
- License: agpl-3.0
- Created: 2024-12-26T17:40:43.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-08T08:01:57.000Z (about 1 month ago)
- Last Synced: 2025-01-16T09:11:04.157Z (about 1 month ago)
- Topics: digital-garden, markdown
- Language: Go
- Homepage: https://markdownbrain.com
- Size: 1.03 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
MarkdownBrain
Make your digital garden with MarkdownBrain.
## Quick Start
### Client
#### Create client config.yml
```bash
echo 'source: "~/Library/Mobile Documents/com~apple~CloudDocs/obsidian/example"
server: "https://your-server-url"
api_key: "1234567890"
ignores:
- "Templates"' > config.yml
```
> Note: The `source` is the path to your Obsidian vault.
#### Run cli
```bash
curl -L https://github.com/blackstorm/markdownbrain/releases/download/v0.1.1/markdownbrain-cli-darwin-amd64 -o markdownbrain-client
chmod +x markdownbrain-client
./markdownbrain-client -c config.yml
```
> Note: Before running the client, ensure the `server` is running.
### Server
#### Create config.yml
```bash
echo 'lang: "en"
root_note_name: "Welcome"
name: "MarkdownBrain"
description: "MarkdownBrain"
api_key: "1234567890"' > config.yml
```
#### Run Server
```bash
docker run -dit --name markdownbrain -v $(pwd)/config.yml:/markdownbrain/config.yml -p 3000:3000 ghcr.io/blackstorm/markdownbrain-server:latest
```
## Documentation
[MarkdownBrain.com](https://markdownbrain.com)
## License
[AGPLv3](LICENSE.md)