Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-adventure/digital-garden
https://github.com/rust-adventure/digital-garden
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/rust-adventure/digital-garden
- Owner: rust-adventure
- Created: 2020-10-09T19:11:38.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-29T04:15:59.000Z (over 1 year ago)
- Last Synced: 2024-04-08T19:17:18.033Z (8 months ago)
- Language: Rust
- Size: 159 KB
- Stars: 20
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - rust-adventure/digital-garden - (others)
- jimsghstars - rust-adventure/digital-garden - (Rust)
README
# Digital Garden
A content authoring tool with bidirectional links and other garden features
## Commands
### Write in your garden
```shell
## open $EDITOR and go through the process of writing interactively
garden write
## write to the sparkfile
garden write -sm something here
## append to a file or create a new one
garden write -t Some Title -m Some message
```
### Search
Garden expects MDX, although we won't be parsing it fully in this course. This leads to two things: bidirectional links and tags. We can search for files by the tag they include.
```shell
garden search -t rust
```
#### Bidirectional Links
```markdown
[[learning rust]]
```
#### Tags
```md
# Metadata
Talking about #rust and other things
```
### Publish
Turn a directory of markdown files into html.
```shell
garden publish -o ./publish
```
## Options
All garden commands accept an environment variable or flag to indicate which garden to operate on.
```shell
## With an ENV var
GARDEN_PATH=~/github/chris/sector garden write
## or the same thing with a flag
garden -p ~/github/chris/sector garden write
```