Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.37 KB

README.md

File metadata and controls

64 lines (48 loc) · 2.37 KB
Raw

Next.js Markdown Editor with Advanced Parsing Live URL

Cloud Vault

This project is a powerful Markdown editor and parser built using Next.js, leveraging SCSS for styling and the Monaco Editor for an enhanced editing experience.

Features

  • Advanced Markdown Parsing: Our custom Markdown parser can handle a variety of syntaxes including headings, bold/italic text, links, images, code blocks, and more.
  • Monaco Editor Integration: Utilizes the Monaco Editor for a rich text editing experience, complete with syntax highlighting and auto-completion.
  • Responsive Design: Styled with SCSS for a clean, responsive user interface that adapts to different screen sizes.
  • Next.js Framework: Built on Next.js, offering server-side rendering and static site generation for a fast and efficient web application.

Technologies Used

  • Next.js: A React framework that enables functionality such as server-side rendering and generating static websites for React-based web applications.
  • SCSS: An extension of CSS that enables using variables, nested rules, mixins, functions, and more.
  • Monaco Editor: A browser-based code editor that powers VS Code, known for its rich features like syntax highlighting and IntelliSense.

Getting Started

To get a local copy up and running, follow these simple steps:

  1. Clone the repo 
    git clone https://github.com/kyawzin-thiha/markdown-parser
  2. Install NPM packages 
    npm install
  3. Run the development server 
    npm run dev
# or
yarn dev

Usage

  • Write Markdown in the Monaco Editor pane.
  • See the live HTML preview on the other pane, rendered from the Markdown input.
  • Enjoy the features like syntax highlighting and live parsing as you type.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.