Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emjjkk/mditor
A simple, open-source markdown editor that is also the fastest way to build the simplest website ever. Built with NextJS
https://github.com/emjjkk/mditor
markdown-editor markdown-parser markdown-viewer nextjs page-builder react-markdown tailwindcss
Last synced: about 2 months ago
JSON representation
A simple, open-source markdown editor that is also the fastest way to build the simplest website ever. Built with NextJS
- Host: GitHub
- URL: https://github.com/emjjkk/mditor
- Owner: emjjkk
- License: mit
- Created: 2024-02-06T09:51:19.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-25T12:31:02.000Z (9 months ago)
- Last Synced: 2024-11-14T08:39:43.226Z (about 2 months ago)
- Topics: markdown-editor, markdown-parser, markdown-viewer, nextjs, page-builder, react-markdown, tailwindcss
- Language: TypeScript
- Homepage: https://mditor.vercel.app
- Size: 323 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mditor - NextJS Markdown Editor
This project was bootstrapped with [Next.js](https://nextjs.org/), a React framework for production.
## Prerequisites
Before running this project, ensure you have the following installed on your local machine:
- [Node.js](https://nodejs.org/) (v14.x or higher)
- [npm](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com/)
## Installation
1. Clone this repository to your local machine:
```bash
git clone https://github.com/KunHnao/Mditor
```
2. Navigate to the project directory:
```bash
cd mditor
```
3. Install project dependencies using npm:
```bash
npm install
```
or using Yarn:
```bash
yarn install
```
## Create .env
If you wish to work with the createPage functionality, create an .env file at the root directory of the project with your postgresql url assigned to the variable `DATABASE_URL`
## Running the Project
Once the dependencies are installed, you can start the development server:
```bash
npm run dev
```
or with Yarn:
```bash
yarn dev
```
This will start the development server at [http://localhost:3000](http://localhost:3000). Open this URL in your browser to view the project.