Skip to content

markdown-docs/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 

Repository files navigation

Markdown Docs Collaborative Editor πŸš€

A powerful, real-time collaborative Markdown editor inspired by Google Docs and Overleaf. Built with React, Phoenix, and Haskell, this project brings team-based editing to the next level with custom .mds format support, Unsplash image embeds, and live synchronization.


Key Features 🌟

  • Real-Time Collaboration:
    Edit Markdown documents with your team simultaneously. See cursors and edits in real-time.

  • Custom .mds Format:
    Extend Markdown with powerful features:

    • !title[Your Title]: Add beautiful document titles.
    • !gif[search term]: Embed GIFs on the fly.
    • !image[unsplash term]: Seamlessly add images from Unsplash.
  • Live Preview:
    Instantly preview Markdown-rendered content as you type.

  • Unsplash Integration:
    Quickly embed stunning, royalty-free images.

  • History Tracking:
    Built-in undo/redo functionality.


Tech Stack βš™οΈ

Component Technology
Frontend React, CodeMirror, react-markdown
Backend Phoenix Framework
Parser Haskell + Pandoc
Database PostgreSQL
APIs Unsplash API

Usage πŸ“–

1. Collaborative Editing

  • Share your document with team members. All changes are synchronized in real-time.

2. Using .mds Features

  • Add titles:
    !title[My Document Title]
  • Embed a GIF:
    !gif[coding cat]
  • Add an Unsplash image:
    !image[forest]

3. Keyboard Shortcuts

  • Ctrl + Z: Undo
  • Ctrl + Y: Redo
  • Ctrl + S: Save Document

Project Structure πŸ“‚

markdown-docs/
β”œβ”€β”€ frontend/        # React frontend
β”œβ”€β”€ backend/         # Phoenix backend
β”œβ”€β”€ parser/          # Haskell-based .mds parser
└── docs/            # Project documentation

Contributing 🀝

We welcome contributions! Follow these steps to get started:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/awesome-feature).
  3. Commit your changes (git commit -m "Add awesome feature").
  4. Push to the branch (git push origin feature/awesome-feature).
  5. Open a pull request.

Roadmap πŸ›€οΈ

  • Basic Markdown editor with live preview.
  • Real-time collaboration with WebSocket support.
  • Custom .mds parser in Haskell.
  • Unsplash API integration.
  • Export to PDF.
  • Mobile-friendly UI.

License πŸ“œ

This project is licensed under the Apache License 2.0.


Contributors ✨


Demo Preview πŸŽ₯

Coming soon...

For questions or feedback, feel free to open an issue.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors