Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yellow-footed-honeyguide/mdflash
Experience the power of instant Markdown previews, just like GitHub, right in your terminal ⚡️
https://github.com/yellow-footed-honeyguide/mdflash
c fast markdown markdown-lang markdown-language markdown-previewer terminal
Last synced: 6 days ago
JSON representation
Experience the power of instant Markdown previews, just like GitHub, right in your terminal ⚡️
- Host: GitHub
- URL: https://github.com/yellow-footed-honeyguide/mdflash
- Owner: yellow-footed-honeyguide
- License: mit
- Created: 2024-06-10T11:59:01.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T14:32:49.000Z (about 2 months ago)
- Last Synced: 2024-09-18T11:04:51.632Z (about 2 months ago)
- Topics: c, fast, markdown, markdown-lang, markdown-language, markdown-previewer, terminal
- Language: C++
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# mdflash - Lightning - Fast Markdown Previews !
Experience the power of instant Markdown previews, just like GitHub, right here, rigth now! ⚡️
***
> **Note:** This project is currently under active development. Some features may be incomplete or subject to change.
> **Project Goals**
> - 🔗 Minimal dependencies
> - 🚀 Maximum performance
> - 🎯 Closest possible match to GitHub's Markdown rendering
***
## Description
mdflash is a lightning-fast utility written in pure C that allows you to preview your Markdown documents with near-zero dependencies! 🚀
Get a taste of GitHub-style Markdown rendering without ever leaving the comfort of your command line! 😎
## Features
🌋 Blazing Fast! ⚡️
Harnessing the raw power of C, mdflash renders your Markdown files at breakneck speeds! Watch your documents come to life in an instant! 🏎💨
🌋 GitHub-Style Previews! 👀
Experience the familiarity and elegance of GitHub's Markdown rendering, right in your terminal! It's like having a piece of GitHub wherever you go! 🐙
🌋 Minimal Dependencies! 🍃
mdflash stands tall and proud with almost zero dependencies! It's a self-contained powerhouse that won't weigh you down! 💪
🌋 Cross-Platform Compatibility! 🌍
Whether you're on Linux, macOS, or Windows, mdflash feels right at home! It's the globe-trotting adventurer of Markdown previews! 🗺
🌋 Open-Source Awesomeness! 🌟
Crafted with love and care, mdflash is an open-source marvel that keeps getting better with every contribution! Join the community and make your mark! 🤝
## Dependencies
mdflash relies on the following dependency:
- Qt 5
## Getting Started
### Dependencies
mdflash is a self-contained, pure C code that stands tall only with GTK library! 🏰
### Installing
Set of steps for installation:
```
git clone https://github.com/yellow-footed-honeyguide/mdflash.git
cd mdflash
mkdir build
cd build
cmake ..
make
```
Now you can install mdflash to /usr/local/bin/
```
sudo make install
```
### Examples of usage
```
$ mdflash Readme.md
```
### Executing program
Demo will be here soon...
## Contributing
Thank you for considering contributing to this project! Here’s how you can help:
1. **Fork & Clone the Repository**
- Fork the repo on GitHub and clone it to your local machine:
```sh
git clone https://github.com/yellow-footed-honeyguide/mdflash.git
cd your-repo
```
2. **Create a Branch**
- Create a new branch for your feature or bugfix:
```sh
git checkout -b feature/your-feature-name
```
3. **Make Changes & Commit**
- Implement your changes, then commit with a clear message:
```sh
git add .
git commit -m "Add feature: your feature name"
```
4. **Push & Create a Pull Request**
- Push your branch and open a pull request:
```sh
git push origin feature/your-feature-name
```
Thank you for your contributions!
## Author
**Sergey Veneckiy**
- Email: [email protected]
- GitHub: [@yellow-footed-honeyguide](https://github.com/yellow-footed-honeyguide)
## License
This project is licensed under the MIT License.
mdflash uses the Qt framework, which is available under various licenses including GPL and LGPL. For more information about Qt licensing, please visit the Qt Licensing page.
## Qt Attribution
This software uses the Qt framework (version 5.x) under the LGPL v3 license.
Qt is Copyright (C) 2023 The Qt Company Ltd. and other contributors.
For more details, see https://www.qt.io/terms-conditions/