Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moisentinel/obsortian
parse yaml frontmatter and sort markdown files
https://github.com/moisentinel/obsortian
markdown obsidian obsidian-md sort yaml
Last synced: about 1 month ago
JSON representation
parse yaml frontmatter and sort markdown files
- Host: GitHub
- URL: https://github.com/moisentinel/obsortian
- Owner: moiSentineL
- License: mit
- Created: 2024-08-18T09:14:20.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-22T14:10:57.000Z (3 months ago)
- Last Synced: 2024-09-30T23:01:20.832Z (about 2 months ago)
- Topics: markdown, obsidian, obsidian-md, sort, yaml
- Language: Python
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# obsortian
sort and find markdown files by yaml frontmatter.
thank you necessity.
---
Tested only on an [Obsidian](https://obsidian.md) vault, but may be used for other stuff that uses markdown and YAML frontmatter.
## Logic:
- Checks for files on a given path
- Removes any "exclusions"
- Checks for properties (if they exist) on the frontmatter
- Prints/ writes the files.### Current usage:
For now, it searches the `tags` and `status` properties in the frontmatter, finds the files and returns a *random* list of 20 files from it. (this is more of a personal thing, working to generalise it.)You can set up which `tag` or `status` to look for in the `conf.json`, and set up the vault path and excluded folders:
```json
{
"vault_path": "/home/nibir/Documents/obsidian_vault/",
"exclusions": ["Templates", "Scripts"], // excluded folder must be in array
"tag": "Study",
"status": "needs work"
}
```## Installation
```bash
git clone https://github.com/moiSentineL/obsortian.gitcd obsortian
python finder.py
```## Contribution
fix the code, goddamit.