yaml-rust
KeenWrite
Our great sponsors
yaml-rust | KeenWrite | |
---|---|---|
4 | 98 | |
597 | 621 | |
- | - | |
0.0 | 0.0 | |
about 1 month ago | 7 months ago | |
Rust | Java | |
Apache License 2.0 | GNU General Public License v3.0 or later |
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.
yaml-rust
-
Project idea: port markdownlint to Rust
Either https://github.com/chyh1990/yaml-rust or https://github.com/dtolnay/serde-yaml for parsing the YAML config file that markdownlint uses
-
Borrow checker not liking recursive walk through a HashMap
Here's the Rust code so far -- the commented portions are my intent via pseudocode. This is part of an implementation where there's a _yaml_hash member that points to yaml_rust's underlying LinkedHashMap. (Also using anyhow's bail! and Result.)
-
How to deal with unmaintained crates? (eg. yaml-rust)
The first thing I did was to find the crate yaml-rust and it seems it isn't really maintained anymore. It has not been updated in a year and there's a lot of PR's and unresolved issues, the CI is broken... So here is my open ended question.
-
YAML and Configuration Files
Currently, my main concern with YAML is that, by the spec, comments are not attached to a particular node (see https://yaml.org/spec/1.2/spec.html#id2767100). As a result, a lot of YAML parsers (like https://github.com/yaml/libyaml and https://github.com/chyh1990/yaml-rust) only filter out the comments during the parsing phase. This makes it less than ideal for a use-case where the configuration file is expected to be modified by both programs and humans.
TOML makes it more trivial to associate comments with a node. This is mainly because the language is simpler though, as the spec is not explicit about that (https://github.com/chyh1990/yaml-rust).
KeenWrite
-
Ask HN: Tell us about your project that's not done yet but you want feedback on
KeenWrite is my free, open-source, cross-platform desktop Markdown editor that can produce beautifully typeset PDFs. I started working on it years ago to help write a novel that has a complex timeline and I couldn't find a text editor that would allow me to integrate a character sheet with the story itself.
https://github.com/DaveJarvis/keenwrite
Tutorials:
* https://www.youtube.com/playlist?list=PLB-WIt1cZYLm1MMx2FBG9...
Here's what I mean by using variables directly:
* https://www.youtube.com/watch?v=CFCqe3A5dFg
CommonMark doesn't propose a standard for bibliographic references. Would anyone find the editor more appealing if it had cross-references and citations?
-
Documentation as Code for Cloud Using PlantUML
My cross-platform desktop text editor, KeenWrite, allows users to define variables in an external YAML file. The editor calls out to Kroki[1] to convert text-based diagrams to SVG. The diagrams can reference variables and are rendered using EchoSVG[2].
KeenWrite[3] can produce PDF documentation from Markdown documents that has PlantUML diagrams with elements stored in an external, machine-readable file. Here are screenshots showing variables on the left, diagram text in the middle, and a real-time render on the right:
* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...
* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...
KeenWrite supports all diagrams offered by Kroki, which includes "diagram-plantuml".
[1]: https://kroki.io/
[2]: https://github.com/css4j/echosvg/
[3]: https://github.com/DaveJarvis/keenwrite
- On why Markdown is not a good, or even a half-decent, markup language
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
- KeenWrite 3.3.2: MermaidJS diagrams (with caveat)
-
Interactive CommonMark Tutorial
Although not interactive, I've created a video series that shows advanced usage of Markdown. Namely R, external variables, diagrams, math, annotations, and a different approach to metadata:
* https://www.youtube.com/playlist?list=PLB-WIt1cZYLm1MMx2FBG9...
Tutorial 4 shows basic Markdown:
* https://www.youtube.com/watch?v=qNbGSiRzx-0
The top-right of each video shows keyboard and mouse clicks to help follow along.[1] My desktop text editor, KeenWrite[2], is used in the tutorials.
[1]: https://github.com/DaveJarvis/kmcaster
[2]: https://github.com/DaveJarvis/keenwrite
-
“Exit Traps” Can Make Your Bash Scripts Way More Robust and Reliable
https://github.com/DaveJarvis/keenwrite/blob/main/scripts/bu...
My template script provides a way to make user-friendly shell scripts. In a script that uses the template, you define the dependencies and their sources:
DEPENDENCIES=(
-
EchoSVG: SVG rasterizer library supporting level 4 selectors (Apache 2)
I didn't create the fork, nor am I affiliated with the project. I use it in my text editor, KeenWrite to rasterize SVG.
-
Millions of dollars in time wasted making papers fit journal guidelines
KeenWrite Themes[1] are instructions that tell ConTeXt how to typeset XHTML documents (content) into PDF files (presentation). I made a tutorial that shows how my FOSS desktop text editor, KeenWrite[3], allows users to write in Markdown to typeset a document against a particular theme.
Before it can be used for scientific papers, it needs cross-references, which, unfortunately, aren't part of the CommonMark specification.
I posit that the vast majority of LaTeX users don't grok how to separate content from presentation. When I asked a question on TeX.SE about how to adjust the line spacing between enumerated items (spanning a couple dozen enumerated lists), the vast majority of people voted for the answer of using `\itemsep0em` to tweak each list ... individually.[4] The correct answer, IMO, is to fix the problem globally, and not waste time tweaking individual lists.
[1]: https://github.com/DaveJarvis/keenwrite-themes
[2]: https://www.youtube.com/watch?v=3QpX70O5S30
[3]: https://github.com/DaveJarvis/keenwrite
[4]: https://tex.stackexchange.com/questions/6081/reduce-space-be...
What are some alternatives?
serde-yaml - Strongly typed YAML library for Rust
markdown-preview.nvim - markdown preview plugin for (neo)vim
serde - Serialization framework for Rust
marktext - 📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
strictyaml - Type-safe YAML parser and validator.
typst - A new markup-based typesetting system that is powerful and easy to learn.
cue - CUE has moved to https://github.com/cue-lang/cue
vim-markdown - Markdown Vim Mode
libyaml-rust - LibYAML bindings for Rust
Zettlr - Your One-Stop Publication Workbench
ytt - YAML templating tool that works on YAML structure instead of text
kroki - Creates diagrams from textual descriptions!