https://github.com/cooklang/cooklang-obsidian
Edit and display CookLang recipes in Obsidian
https://github.com/cooklang/cooklang-obsidian
cooklang obsidian obsidian-md obsidian-plugin
Last synced: 2 months ago
JSON representation
Edit and display CookLang recipes in Obsidian
- Host: GitHub
- URL: https://github.com/cooklang/cooklang-obsidian
- Owner: cooklang
- License: mit
- Created: 2021-11-01T23:37:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-10T13:07:03.000Z (6 months ago)
- Last Synced: 2024-11-10T14:18:51.390Z (6 months ago)
- Topics: cooklang, obsidian, obsidian-md, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 1.21 MB
- Stars: 212
- Watchers: 12
- Forks: 16
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CookLang Editor Obsidian Plugin
[](https://github.com/deathau/cooklang-obsidian/releases/latest)
A plugin for [Obsidian](https://obsidian.md) adding support for [CookLang](https://cooklang.org)
## Installation
- This plugin has been submitted community plugins repo. You can install it from Communinty Plugins within Obsidian.
- You can build and install the plugin manually by checking out the files to `/.obsidian/plugins/cooklang-obsidian` and running `npm install` and then `npm run build`.
## Security
> Third-party plugins can access files on your computer, connect to the internet, and even install additional programs.
The source code of this plugin is available on GitHub for you to audit yourself, but installing plugins into Obsidian is a matter of trust.
I can assure you here that I do nothing to collect your data, send information to the internet or otherwise do anything nefarious with your system. However, be aware that I *could*, and without auditing the code yourself, you only have my word that I don't.
# Roadmap
This is the stuff I would ideally like to include in this plugin that isn't available as yet:
- [x] Improve editor/preview mode buttons to be more like markdown
- [x] Command to convert `.md` to `.cook`
- [ ] Maybe also `cook` code block support?
- [x] Include option for showing quantities inline in the method
- [ ] Option to link between ingredients and method?
- [x] Include options for showing ingredients list, tools list and time
- [x] (calculate total time)
- [ ] Unit conversion (metric <-> imperial)
- [ ] Scaling up/down (check spec)
- [ ] Shopping list and `.conf` file support (needs designing)
- [ ] Better metadata support.
- [ ] Making source links clickable.
- [ ] Support for Obsidian tagging.
- [ ] (Maybe, pending feedback) Markdown formatting support.
# Version History
## 0.3.0
- Separated out the CookLang parsing code into its own library, and brought it up to date with the latest CookLang spec (so things like named timers are now supported properly)
- Added more options for displaying timers
- Added the ability to click on a timer and show a countdown
- it also optionally plays a sound while the timer is running and when it's finished
- This feature is still pretty new and probably needs more testing
## 0.2.0
- Changed comment syntax according to spec changes
## 0.1.1
- **Fixed:** Turning off inline measurements now actually removes all of them.
- **New:** Added commands to add new recipe files.
## 0.1.0
- Improve editor/preview mode buttons to be more like markdown views
- You can even ctrl/cmd click to open in new pane!
- Include options for showing ingredients list, tools list and time
- Include option for showing quantities inline in the method
## 0.0.4
- Command to convert `.md` to `.cook`
## 0.0.3
- Fixes an issue preventing preview mode from working if no image is present
## 0.0.1
Initial release!
- You can open and edit `.cook` files
- There is an edit view with syntax highlighting
- There is also a preview view which displays the ingredients and amounts at the top like a traditional recipe
and numbers the steps.
- If images are provided (as per the [CookLang convention](https://cooklang.org/docs/spec/#adding-pictures) ) they will also be displayed.