https://github.com/markboard-io/markboard

Wysiwyg markdown whiteboard for note-taking and building team knowledge base.
https://github.com/markboard-io/markboard

chatgpt collaboration collabration digital-whiteboard markdown markdown-editor markdown-whiteboard miro miro-alternative note-taking notebook notion notion-alternative onenote onenote-alternative virtual-whiteboard whiteboard wysiwyg wysiwyg-editor wysiwyg-markdown

Last synced: 29 days ago
JSON representation

Wysiwyg markdown whiteboard for note-taking and building team knowledge base.

• Host: GitHub
• URL: https://github.com/markboard-io/markboard
• Owner: markboard-io
• License: mit
• Created: 2022-12-27T07:35:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-10T01:16:47.000Z (over 1 year ago)
• Last Synced: 2024-09-29T19:02:56.887Z (about 1 month ago)
• Topics: chatgpt, collaboration, collabration, digital-whiteboard, markdown, markdown-editor, markdown-whiteboard, miro, miro-alternative, note-taking, notebook, notion, notion-alternative, onenote, onenote-alternative, virtual-whiteboard, whiteboard, wysiwyg, wysiwyg-editor, wysiwyg-markdown
• Language: TypeScript
• Homepage: https://markboard.io
• Size: 18.4 MB
• Stars: 208
• Watchers: 7
• Forks: 28
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

  



Wysiwyg markdown whiteboard for note-taking and building team knowledge base.




 

 

 









[Markboard](https://markboard.io) brings together **Markdown** and **Whiteboard** for all your writing, diagramming, sketching, and drawing needs in one place, making your creative process more efficient and effective.

Say goodbye to the hassle of switching between different tools and hello to a more streamlined and collaborative workflow. Try markboard.io now to revolutionize your creative process!

## Core Features

[Website](https://markboard.io) • [Live Demo](https://markboard.io/login?demo=1) • [Open Server](https://markboard.io) • [Docs](https://markboard.io/docs) • [Blog](https://markboard.io/blog)

- Collaborative whiteboard

- Wysiwyg markdown

- Cocreate with AI

- Easy to share and publish

## Installation Guide

markboard is an open-source software, you can deploy markboard on your own server without any concern, or you can use our SaaS version by visiting [markboard.io](https://markboard.io).

We officially provide 3 ways of deployment: Digital Ocean, Docker Images and Manual Installation.

### Deploy via DigitalOcean

Deploying markboard with [DigitalOcean](digitalocean.com) is the recommended way to have your own instance running, especially if you are not an expert in linux server or tired of typing a set of commands manually.

Click the folloying button to get your first markboard instance running in minutes:



  

  

  



The cost of DigitalOcean's deployment is super low, starting from $5 per instance per month. Our official server [markboard.io](https://markboard.io) is deployed on DigitalOcean too.

### Deploy via docker

> TODO

### Deploy via manual installation

> TODO

## Local Development

```bash

meteor npm install # install dependencies

npm start # local dev

npm start -- --port=1234 # run local dev on port 1234

npm run lint # lint

npm t # test

meteor shell # debugging

```

### Notable Used Tools

- [meteor](https://github.com/meteor/meteor) Meteor, the JavaScript App Platform.

- [excalidraw](https://github.com/excalidraw/excalidraw) Virtual whiteboard for sketching hand-drawn like diagrams.

- [lexical](https://github.com/facebook/lexical) Lexical is an extensible text editor framework that provides excellent reliability, accessibility and performance.

- [yjs](https://github.com/yjs/yjs) A CRDT framework with a powerful abstraction of shared data

### License

[MIT](./LICENSE)