https://github.com/greeenboi/markdown-superset-compiler
Compiler build on ruby to compile gh-flavor and more markdown to html for the web to render
https://github.com/greeenboi/markdown-superset-compiler
cli-ui markdown ruby ruby-gem shopify-cli tui
Last synced: 4 months ago
JSON representation
Compiler build on ruby to compile gh-flavor and more markdown to html for the web to render
- Host: GitHub
- URL: https://github.com/greeenboi/markdown-superset-compiler
- Owner: greeenboi
- License: mit
- Created: 2025-02-11T14:07:59.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-13T14:16:42.000Z (over 1 year ago)
- Last Synced: 2025-12-03T12:53:37.211Z (6 months ago)
- Topics: cli-ui, markdown, ruby, ruby-gem, shopify-cli, tui
- Language: Ruby
- Homepage: https://rubygems.org/gems/markleft
- Size: 82 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MarkLeft: A Superset to Markdown-to-HTML Compilers
## Overview
MarkLeft is a powerful and flexible tool designed to extend the capabilities of traditional Markdown-to-HTML compilers. It introduces additional syntax and features to enhance the expressiveness and functionality of Markdown documents.
> [!TIP]
> MarkLeft is a work in progress and is currently under development. Please check back for updates and new features.
> You are still free to use it and contribute to it.
## Features
- **Superfast**: MarkLeft is designed to be fast and efficient, processing Markdown files quickly and generating HTML output in an instant.
- **Extensible**: MarkLeft is highly extensible, allowing users to define custom syntax and features to suit their needs.
- **Customizable**: MarkLeft provides a range of options and settings to customize the output, including themes, styles, and more.(coming soon)
## Prerequisites
- Ruby >~ 3.2.4
- Bundler =2.6.3
## Installation
To install MarkLeft, clone the repository and navigate to the project directory:
#### Gem
```sh
gem install markleft
```
#### Repository
```sh
git clone git@github.com:greeenboi/markdown-superset-compiler.git
cd markdown-superset-compiler
```
## Running the Converter
#### Using Gem
```shell
markleft
```
0r
```shell
markleft --file
```
#### Using `markleft-main.rb`
The `markleft-main.rb` file is a simple script that reads a Markdown file, tokenizes it, parses it, and generates HTML output.
1. Run the script:
```sh
ruby lib/markleft.rb
```
2. Follow the prompts to select a Markdown file and process it.
## Example
Given a sample Markdown file `sample.md`:
```markdown
This is a sample *Markdown* file
**bold** yippee!
```
## Contributing
We welcome contributions to enhance MarkLeft. Please fork the repository and submit pull requests with your improvements.
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
## Contact
For any questions or feedback, please contact [contact@suvangs.tech](mailto:contact@suvangs.tech).
---