https://github.com/MkDocsEditor/MkDocsEditor-Web

MkDocsEditor web client.
https://github.com/MkDocsEditor/MkDocsEditor-Web

differential-synchronization editor hacktoberfest markdown markdown-editor mkdocs realtime-collaboration realtime-editing vuejs webapp websocket-client

Last synced: 2 months ago
JSON representation

MkDocsEditor web client.

• Host: GitHub
• URL: https://github.com/MkDocsEditor/MkDocsEditor-Web
• Owner: MkDocsEditor
• License: agpl-3.0
• Created: 2019-01-11T13:45:51.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T22:21:14.000Z (about 2 years ago)
• Last Synced: 2024-08-01T12:31:20.459Z (5 months ago)
• Topics: differential-synchronization, editor, hacktoberfest, markdown, markdown-editor, mkdocs, realtime-collaboration, realtime-editing, vuejs, webapp, websocket-client
• Language: JavaScript
• Homepage:
• Size: 2.38 MB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - MkDocsEditor/MkDocsEditor-Web - MkDocsEditor web client. (hacktoberfest)

README

        


   



# MkDocsEditor-Web

MkDocsEditor web client.

[![Netlify Status](https://api.netlify.com/api/v1/badges/dd328233-3e6d-4fd8-8cf1-ce036691592b/deploy-status)](https://mkdocseditor.netlify.app/#/)

# :warning: Work In Progress

This project is still a work in progress and is **not yet ready for production**.

# Developer Instructions

## Project setup

```

npm install -g @vue/cli

npm install -g @vue/cli-service-global

```

### Compiles and hot-reloads for development

```

npm run serve

```

User friendly debugging in chrome:

```

https://github.com/vuejs/vue-devtools#vue-devtools

```

### Compiles and minifies for production

```

npm run build

```

### Lints and fixes files

```

npm run lint

```

# Contributing

GitHub is for social coding: if you want to write code, I encourage

contributions through pull requests from forks of this repository.

Create GitHub tickets for bugs and new features and comment on the ones

that you are interested in.

# License

**AGPLv3+**