yamh 0.1.1 copy "yamh: ^0.1.1" to clipboard
yamh: ^0.1.1 copied to clipboard

outdated

A dirt simple, null-safe Markdown to HTML converter.

Yet Another Markdown to HTML converter #

A dirt simple, null-safe Markdown to HTML converter.

Features #

  • Functions for both Dart and Flutter*
  • FFI compatiblity compilation*
  • Support for either string input or file input
  • Batch parse Markdown files*
  • Available for NPM**
  • Powers a WTFF***
  • Written in Dart (because I felt like it)

* Planned features; not complete or in the latest build yet.

** This would actually be really nice to make things compile way faster with several files. Planned, but not guaranteed.

*** This is just an idea of mine that I may or may not do. Stands for Way Too Fast Framework and would be used for websites.

Usage #

Command-line usage #

You can see the usage information provided by running ./yamh -h or ./yamh --help. All of these commands are flags/options for the ./yamh command and should be appended to it.

  • -f, --file <file>&mdash; Parse a Markdown file to HTML, where <file> is the path to a Markdown file.
  • -s, --string <string>&mdash; Parse a string containing Markdown to HTML, where <string> is the aforementioned string.
  • -o, --out <out-dir>&mdash; Specify a place for converted HTML files to go.
    • If you are using the -s option, it will default to saving in the console.
    • If you are using the -f option, it will default to saving in the same directory as the Markdown file.

in Dart and Flutter #

This has not been implemented yet. When it is, this will be updated to show the relevant documentation.

in Node/NPM #

This has not been implemented yet. When it is, this will be updated to show the relevant documentation. It may also never happen, due to a lack of knowledge.

Building #

  1. Install Dart
  2. Fetch dependencies (dart pub get)
  3. Build the binaries (dart2native bin/yamh.dart -o build/yamh.ext; replacing « ext » with « exe » if on Windows or « app » if on macOS)

Acknowledgements #

This project is licensed under the MIT License. You can see a copy of it in the LICENSE file in the root of this repository.

Special thanks to:

  • the Dart team for having great documenation of the language,
  • the Flutter team for having amazing documentation of the utility; and:
  • all of the dependencies of YAMH for helping power this tool.

This was made to try and cross off the "Markdown to HTML converter" here. Although it does function for other things, you can have a single binary to interact with for all your needs.

1
likes
0
pub points
0%
popularity

Publisher

verified publisherdoamatto.xyz

A dirt simple, null-safe Markdown to HTML converter.

Repository (GitHub)
View/report issues

Documentation

Documentation

License

unknown (LICENSE)

Dependencies

args, markdown

More

Packages that depend on yamh