kevenleone / mdreader

Save and Read your favorite markdown documents from Github.

Home Page:https://mdreader.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MD Reader

Effortlessly organize your favorite Markdown into 'Articles' that are both easy to manage and share with others. Say goodbye to cluttered notes and hello to a sleek, streamlined system that puts your ideas front and center.

Description

Save and organize your favorites markdown files in a single storage and share with friends and team.

⚡ Installation and Instructions

  • Install the packages yarn

Folder Structure

  • apps/mdreader
    • Main application using Vite
  • packages/markdown
    • Component Library responsible for rendering Articles (.md files)
    • Renderer made with rehype and remark libraries.
  • packages/interface
apps/mdreader
packages/markdown
packages/interface

Motivation

Organizing content and favorites is a difficult job, especially when they are markdown files mirrored in random repositories, as I have the habit of searching documents on Github, many of them focused on good practices and usage guides the favorite button and selecting by topics becomes a little harder.

The aim of the project is to centralize these valuable documents and save them to your profile, you can create articles and folders for organization and the project nicely displays the markdown content.

🤝 Contributing

If you liked the project and want to cooperate feel free to fork this repository and send Pull Requests.

All kinds of contributions are very welcome and appreciated

  • ⭐️ Star the project
  • 🐛 Find and report issues
  • 📥 Submit PRs to help solve issues or add features

📖 License

MIT license, Copyright (c) 2023 Keven Leone.

About

Save and Read your favorite markdown documents from Github.

https://mdreader.vercel.app

License:MIT License


Languages

Language:TypeScript 93.7%Language:CSS 3.2%Language:JavaScript 3.1%Language:Shell 0.1%