noyaml
obsidian-api
noyaml | obsidian-api | |
---|---|---|
9 | 18 | |
416 | 1,611 | |
- | 1.9% | |
5.3 | 7.0 | |
2 months ago | about 1 month ago | |
CSS | ||
GNU Affero General Public License v3.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
noyaml
-
Kubernetes Through the Developer's Perspective
Most commonly written in YAML, these files are large and complex to read and understand. And being written in YAML comes with its challenges (and quirks) since it is an additional programming language that devs need to learn.
-
JSON Canvas – An open file format for infinite canvas data
YAML is kind of like C++:
> You like C++ because you're only using 20% of it. And that's fine, everyone only uses 20% of C++, the problem is that everyone uses a different 20% :)
https://eli.thegreenplace.net/2009/10/17/the-c-bashing-seaso...
The YAML footguns are too numerous to reproduce here, so here are some sources:
https://stackoverflow.com/questions/3790454/how-do-i-break-a...
https://www.arp242.net/yaml-config.html
https://noyaml.com/
-
Why the fuck are we templating YAML? (2019)
Relevant: https://noyaml.com/
YAML and its ecosystem is full of footguns and ergonomics problems, especially when the length of the document extends beyond the height of a user's editor or viewport. Loss of context with indentation, non-compliant or unsafe parsers, and strange boolean handling to name a few.
It becomes even worse when people decide that static YAML data files should have variable substitution or control flow via templating. "Stringly-typed programming" if you will. If we all started writing JSON text templates I think a lot of people would rightly argue we should write small stdlib-only programs in Python, Typescript, or Ruby to emit this JSON instead of using templated text files. Then it becomes apparent that the YAML template isn't a static data file at all, but part of a program which emits YAML as output. We're already exposing people to basic programming if we're using YAML templates. People brew a special kind of YAML-templated devops hell using tools like Kustomize and Helm, each of which are "just YAML" but are full of idiosyncracies and tool-specific behaviour which make the use of YAML almost coincidental rather than a necessity.
Yes, sometimes people would prefer to look at YAML instead of JSON, in which case I suggest you use a YAML serialization library, or pipe output into a tool like `yq` so you can view the pretty output. In a pinch you could even output JSON and then feed it through a YAML formatter.
The Kubernetes community seems to have this penetrating "oh, it's just YAML" philosophy which means we get mediocre DSLs in "just YAML" which actually encode a lot of nuanced and unintuitive behaviour which varies from tool to tool.
Look at kyverno, for examle: it uses _parentheses_ in YAML key names to change the semantics of security policies! https://kyverno.io/docs/writing-policies/validate/ . This is different to what I think is the (much better ideas of) something like kubewarden, gatekeeper, or jspolicy, which allow engineers to write their policies in anything that compiles to WASM, OPA, and Typescript/Javascript respectively.
We engineers, as a discipline, have decades of know-how building and using general purpose programming languages with type checkers, linters, packaging systems, and other tools, but we throw them all away as soon as YAML comes along. It's time to put the stringified YAML templates away and engage in the ecosystem of mature tools we already to use to perform one simple task they are already good at: dumping JSON on stdout.
Let's move the control flow back into the tool and out of the YAML.
-
YAML's homepage is displayed in YAML
The webpage documenting some of the sharp edges of yaml is also displayed as an editable yaml document
https://noyaml.com/
-
stopDoingJson
It’s the least secure config format, even worse than XML IMO since it’s unsafe even with trusted inputs. https://noyaml.com/
- That's a Lot of YAML
obsidian-api
-
JSON Canvas – An open file format for infinite canvas data
I really like that you commit to keep this stable and open.
Do you plan to make the TypeScript definition part of this new site?
https://github.com/obsidianmd/obsidian-api/blob/master/canva...
For me it's easier to read TS format.
-
Love Letter to Obsidian
The Canvas feature is a custom file format, but they published the format here: https://github.com/obsidianmd/obsidian-api/blob/master/canva...
If Obsidian goes under or you want to migrate at least your data isn't lost.
-
Does Obsidian hold any patents, or feature-related intellectual property?
Obsidian is closed source so you won't be infringing their copyright by incorrectly getting/copying their code within your code. I don't believe they have any software patents (too small a company), and the canvas data format is available under MIT license (https://github.com/obsidianmd/obsidian-api/blob/master/canvas.d.ts). Even if you decided to reproduce their plugin APIs (so that existing Obsidian plugins could be reused with your software), you'd be fine per https://en.wikipedia.org/wiki/Google_LLC_v._Oracle_America,_Inc. (but their API definition is under MIT license anyway: https://github.com/obsidianmd/obsidian-api/tree/master)
-
Good starting point for learning more technical things?
I would start with with the obsidian api docs and the obsidian plugin docs then feed it into a gpt document loader and ask gpt the same thing you asked here. Obsidian offers a couple different “talk to your notes” plugins using gpt (all you need is an open ai api key) if you’re looking for a streamlined “ai document loader” you could just copy and paste the info into a new note once you have the plugin installed.
- Templater obtain name of previous active link, or parent note.
-
Is there way to run Obsidian command from the shell?
In any event, there are no CLI flags to do that at the moment. The canvas format is very new, and not part of the standard markdown format. There is a public specification for it, but it's up to developers to make applications supporting it.
-
Why not open sourcing ?
Canvas has been an open standard since its release.
-
Does Obsidian suitable for my usecase (I use Notion + OneNote)?
As far as I know, any API that can be used by end users and plugin developers (as described in the previous post) is considered public. You can find the API repo here and definitions in this file.
- obsidian-api: Type definitions for the latest Obsidian API.
-
Obsidian Canvas is here!
The .canvas format is a simple JSON-based format that is designed to be easy to parse. We've already seen several plugins leverage this and hope to see even more tools outside of Obsidian. You can see the spec here.
What are some alternatives?
yj - CLI - Convert between YAML, TOML, JSON, and HCL. Preserves map order.
obsidian-livesync
hjson - Hjson, a user interface for JSON
fleeting-notes-quartz - Notes that extend your brain
doximus - static, smart and developer friendly API documentation generator
obsidian-bartender - Allows for rearranging the elements in the status bar and sidebar ribbon
json2jsii - Generates jsii-compatible structs from JSON schemas
obsidian-note-linker - 🔗 Automatically link your Obsidian notes.
PyYAML
obsidian-sample-plugin
crd-to-sample-yaml - Generate a sample YAML file from a CRD
rextract - A simple toolchain for moving Remarkable highlights to Readwise