https://github.com/ttiimmothy/markdown-previewer-application

Markdown previewer application to drop down the notes in markdown format
https://github.com/ttiimmothy/markdown-previewer-application

react react-markdown styled-components typescript vite

Last synced: 5 days ago
JSON representation

Markdown previewer application to drop down the notes in markdown format

• Host: GitHub
• URL: https://github.com/ttiimmothy/markdown-previewer-application
• Owner: ttiimmothy
• License: gpl-3.0
• Created: 2023-10-10T19:24:15.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-17T06:24:27.000Z (about 1 year ago)
• Last Synced: 2024-04-24T03:00:41.777Z (7 months ago)
• Topics: react, react-markdown, styled-components, typescript, vite
• Language: TypeScript
• Homepage: https://markdownpreviewerapplication.netlify.app/
• Size: 112 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Markdown Previewer Application

[![ci](https://github.com/ttiimmothy/markdown-previewer-application/actions/workflows/ci.yml/badge.svg)](https://github.com/ttiimmothy/markdown-previewer-application/actions/workflows/ci.yml)

A markdown previewer application uses `Typescript`, `React.js` amd `Vite`. It uses `Styled Components` for simplifying CSS usage.

## 🎯 Features

- markdown guide

- markdown input

- markdown output

## 🖥 Prerequisites

- Node.js (version 12.0 or above)

- npm (which comes with Node.js) or Yarn (version 1.22.0 or above)

## 🔧 Usage

### Build and Run

```TypeScript

npm i

npm run dev

```

## License

Markdown Preview Application is licensed under [GNU General Public License v3.0](LICENSE).