Giter Club home page Giter Club logo

merken's Introduction

Merken

Description

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.

Prerequisites

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

Tech Stack

  • 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 structure

$PROJECT_ROOT# Global CSS
├── assets
│   # Vue.js component files
├── components
│   # User Configuration
├── user
│   # Page files
├── view
│   # Global functions
└── helpers.ts

Contributing to Merken

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!

License

Selhorst © 2023 // Some reserved rights.

Contact

Contact by my social networks that are in my README

Kaik Selhorst Picture (Fox)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.