Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rgrannell1/obs-diatom

Extract structured data from Obsidian notes
https://github.com/rgrannell1/obs-diatom

obsidian-md

Last synced: 23 days ago
JSON representation

Extract structured data from Obsidian notes

Awesome Lists containing this project

README

        

# Diatom

Read and store Obsidian notes as structured data.

## Usage

```bash
diatom
```

## Description

Diatom extracts information from human-readable markdown into a Sqlite database.

- File names, titles, and hashes
- Tags in a file
- Urls in a file
- Wikilinks in a file, their alias
- Note frontmatter
- Code-blocks with an information section starting with an `!`

This database can then be used by applications that read or modify your notes.

## Tables

Diatom extracts note-information into the following tables:

`file: { id, title, hash }`

`tag: { tag, file_id }`

`url: { url, file_id }`

`wikilink: { reference, alias, file_id }`

`metadata { file_id, schema, content }`

## License

The MIT License

Copyright (c) 2021 Róisín Grannell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.