Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2kabhishek/clearup
Clearup your markdown ✒️🤓
https://github.com/2kabhishek/clearup
babel bulma markdown-editor marked minimal react
Last synced: about 1 month ago
JSON representation
Clearup your markdown ✒️🤓
- Host: GitHub
- URL: https://github.com/2kabhishek/clearup
- Owner: 2KAbhishek
- License: gpl-3.0
- Created: 2022-01-24T21:08:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-16T07:39:40.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T16:27:01.005Z (8 months ago)
- Topics: babel, bulma, markdown-editor, marked, minimal, react
- Language: JavaScript
- Homepage: https://2kabhishek.github.io/clearup
- Size: 62.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## What is this
clearup is a markdown editor, with support for live previews that allows you to quickly create beautiful markdown documents.
## Inspiration
Wanted to build my own markdown editor with a minimalistic feel.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of `any web browser`
## Getting clearup
To install clearup, follow these steps:
```bash
git clone https://github.com/2kabhishek/clearup
cd clearup
```
## How it was built
clearup was built using [React](https://reactjs.org/), [Babel](https://babeljs.io/), [Bulma](https://bulma.io/) and [Marked](https://marked.js.org/) .
## Challenges faced
The main challenge was to setup react and babel in the browser, without using create-react-app or npm.
## What I learned
- Got to try out `babel` on the browser
- Learned a quick way to create a `react` app without much scaffolding
- Learned about `marked` and few other libraries
## What's next
Better code syntax highlighting with [Prism](https://prismjs.com/).
Hit the ⭐ button if you found this useful.
## More Info
