{"id":15048623,"url":"https://github.com/rabbithole26/md-preview","last_synced_at":"2026-03-16T20:02:34.452Z","repository":{"id":243916243,"uuid":"813700867","full_name":"RabbitHole26/md-preview","owner":"RabbitHole26","description":"Simple Markdown editor with a preview built with React. It has capability to store and manage Markdown snippets.","archived":false,"fork":false,"pushed_at":"2025-02-08T17:02:33.000Z","size":1099,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-13T23:21:41.271Z","etag":null,"topics":["markdown-editor","markdown-preview","reactjs"],"latest_commit_sha":null,"homepage":"https://md-preview.onrender.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RabbitHole26.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-11T15:17:35.000Z","updated_at":"2025-02-08T17:02:37.000Z","dependencies_parsed_at":"2024-08-02T12:29:38.402Z","dependency_job_id":"f36b55fe-4d79-4330-b720-34dbcd5dfe6d","html_url":"https://github.com/RabbitHole26/md-preview","commit_stats":null,"previous_names":["rabbithole26/md-preview-public"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RabbitHole26%2Fmd-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RabbitHole26%2Fmd-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RabbitHole26%2Fmd-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RabbitHole26%2Fmd-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RabbitHole26","download_url":"https://codeload.github.com/RabbitHole26/md-preview/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243495376,"owners_count":20299924,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown-editor","markdown-preview","reactjs"],"created_at":"2024-09-24T21:14:34.024Z","updated_at":"2025-12-28T20:20:56.495Z","avatar_url":"https://github.com/RabbitHole26.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MD-Preview\n\n**MD-Preview** is a Markdown editor with a built-in preview functionality. It is designed to provide a simple and efficient way for users to write and visualize Markdown content. This project is a basic yet functional tool, suitable for anyone who needs to work with Markdown.\n\n### Key Features\n\n* **Real-Time Preview**: Displays your Markdown rendering live as you type.\n* **User Account System**: Allows users to create accounts to manage their work.\n* **Snippet Management**: Enables users to store, update, delete, and rename their Markdown snippets.\n* **Theme Customization**: Users can switch between light and dark themes for a better user experience.\n* **Supabase Backend**: Uses Supabase to handle backend services, ensuring data is stored securely. Currently, the Supabase authentication module is leveraged to store user generated data.\n\n### Technical Details\n\n* **Frontend**: Build with _REACT_.\n* **Backend**: Powered by _Supabase_.\n\n### Development Status\n\nThis is a work in progress (WIP) project. While the core functionality — such as real-time preview, user account system, snippet management, theme customization, and backend integration with Supabase — is working as intended, there are still some missing features and areas that need improvement.\n\n## Installation\n\nTo get started with MD-Preview, follow these steps:\n\n1. Clone the repository:\n      \n    ```bash\n    git clone \u003cproject_url\u003e\n    ```\n\n2. Create the **.env** file in the root directory of your project:\n    * You can use the provided **.env.example** file as a template.\n3. Set up Supabase:\n    * Create a Supabase account if you haven't already at [Supabase](https://supabase.com/).\n    * Once logged in, start a new project and open it.\n    * To configure your environment variables in the **.env** file:\n      1. Determine your Supabase project's URL and API key. These can be found in [Project API settings](https://supabase.com/dashboard/project/_/settings/api).\n      2. Define the following variables in your **.env** file:\n          * \u003cspan style='color: orange'\u003eVITE_SUPABASE_URL\u003c/span\u003e=`\u003cyour_supabase_project_url\u003e`\n          * \u003cspan style='color: orange'\u003eVITE_SUPABASE_KEY\u003c/span\u003e=`\u003cyour_supabase_api_key\u003e`\n\n## SRC directory structure with selected elements\n\n```\n├── src\n    ├── assets\n    ├── components\n    │   │\n    │   │   ## styled input field with validation and error rendering \n    │   ├── inputs\n    │   │\n    ├── pages\n    ├── store\n    │   │\n    │   │   ## Context for authentication\n    │   ├── auth-context\n    │   │ \n    │   │   ## Context for managing loading states\n    │   ├── loading-context \n    │   │\n    │   │   ## Context for handling local storage operations\n    │   ├── localstorage-context \n    │   │\n    │   │   ## Context for Markdown preview functionality\n    │   ├── preview-context\n    │   │\n    │   │   ## Client utility for interfacing with Supabase\n    │   ├── supabase-client \n    │   │\n    │   │   ## Custom hooks for interacting with Supabase\n    │   ├── supabase-hooks \n    │   │\n    │   │   ## Context for managing theme customization\n    │   └── theme-context \n    │   \n    └── utils\n\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frabbithole26%2Fmd-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frabbithole26%2Fmd-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frabbithole26%2Fmd-preview/lists"}