Merken is a web application for easy editing of markdown-style text. It offers a live preview allowing the user to see what is written and make changes in real time. This tool also offers customization of themas and font families to adapt to your writing style. Merken is ideal for anyone who needs a powerful markdown editor with professional features.
To start the project the first step is to download and install Node.js, which is a JavaScript development platform that makes it possible to run JavaScript code outside the browser. Also, if you are using Vscode, you need to download the TypeScript Vue Plugin extension (volar). Both are minimum requirements to start the project.
$ npm install # Install all dependencies
# Exist 3 options for project startup
$ npm run dev # Developement mode
$ npm run build # Production mode
$ npm run lint # Use diferent lint config- Marked - A markdown parser and compiler. Built for speed.
- Vue.js - Focus on the content while having the power of HTML and Vue components whenever needed.
- Vue Router - Expressive, configurable and convenient routing for Vue.js.
- Vite - An extremely fast frontend tooling.
- Mitt - Functional event emitter.
- TypeScript - JavaScript with syntax for types.
- Pinia - The intuitive store for Vue.js
$PROJECT_ROOT
│ # Global CSS
├── assets
│ # Vue.js component files
├── components
│ # User Configuration
├── user
│ # Page files
├── view
│ # Global functions
└── helpers.ts
Making contributions to Project Merken is a great way to collaborate with the community. Whether it's creating new themes, adding new features or improving performance, any contribution is welcome! Merken is always looking for improvements and feedback to make the project better, so join the Merken family and do your part!
Selhorst © 2023 // Some reserved rights.
Contact by my social networks that are in my README
