50 lines
981 B
Markdown
50 lines
981 B
Markdown
|
# Quickstart: Relational Document System
|
||
|
|
|
||
|
|
This guide provides a quick overview of how to use the relational document system.
|
||
|
|
|
||
|
|
## 1. Create a Document
|
||
|
|
|
||
|
|
Create a new markdown file (e.g., `people/john-doe.md`) with YAML frontmatter:
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
---
|
||
|
|
type: person
|
||
|
|
name: John Doe
|
||
|
|
email: john.doe@example.com
|
||
|
|
---
|
||
|
|
|
||
|
|
# John Doe
|
||
|
|
|
||
|
|
This is a document about John Doe.
|
||
|
|
```
|
||
|
|
|
||
|
|
## 2. Create a Query
|
||
|
|
|
||
|
|
Create a new markdown file to define a query (e.g., `views/all-people.md`):
|
||
|
|
|
||
|
|
````markdown
|
||
|
|
```notex
|
||
|
|
query: person
|
||
|
|
sort_by: name
|
||
|
|
```
|
||
|
|
````
|
||
|
|
|
||
|
|
## 3. View the Results
|
||
|
|
|
||
|
|
When you open the `views/all-people.md` file, the plugin will execute the query and display the results in a virtual buffer:
|
||
|
|
|
||
|
|
```
|
||
|
|
| name | email |
|
||
|
|
|----------|------------------------|
|
||
|
|
| John Doe | john.doe@example.com |
|
||
|
|
| ... | ... |
|
||
|
|
```
|
||
|
|
|
||
|
|
## 4. Linking Documents
|
||
|
|
|
||
|
|
You can link to other documents using the standard markdown syntax:
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
See also: [John Doe](people/john-doe.md)
|
||
|
|
```
|