README.md

Markvite [WIP]

Using web extensions to enhance Markdown syntax

Features

1. 📂 Portability: Generate a single HTML and PDF file for easy sharing and distribution, without the need for additional software or dependencies
2. 🔧 Customization: Extend Markdown syntax using web technologies and support importing Vue components to meet users' personalized needs, expand functionality, and styles
3. 🌓 Themes: Support light and dark modes, providing a comfortable reading experience and personalized choices
4. ⚡️ Development efficiency: Utilize Vite as a modern front-end build tool and development server for fast and efficient development
5. 🎨 Styling: Employ Unocss, an atomic CSS engine, to simplify style management, improve code reusability, and reduce project file size

Quick Start

1. Clone

git clone https://github.com/viarotel-org/markvite.git

2. Install dependencies

npm install

3. Run

npm run dev

4. Build

npm run build

Getting Help

As this is an open source project run entirely by donations, support is limited and updates may not be on a fixed schedule.

• Issues: Submit Feedback
• Email: [email protected]
• WeChat: viarotel
• QQ: 523469508

Acknowledgements

This project would not be possible without the following open source projects:

• vite
• vue
• github-markdown-css
• vite-plugin-singlefile
• unplugin-vue-markdown
• electron-pdf
• unocss

Support the Project

If this project has helped you, you can buy me a coffee to keep me energized and improving the project! 😛