https://github.com/twhite96/checkyoself

Markdown Grammar Checker for blog posts, etc.
https://github.com/twhite96/checkyoself

grammar grammar-checker markdown-editor markdown-parser spelling-checker

Last synced: 6 months ago
JSON representation

Markdown Grammar Checker for blog posts, etc.

• Host: GitHub
• URL: https://github.com/twhite96/checkyoself
• Owner: twhite96
• License: mit
• Created: 2017-04-09T23:20:52.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-09-17T00:15:35.000Z (about 2 years ago)
• Last Synced: 2025-04-03T14:43:48.821Z (6 months ago)
• Topics: grammar, grammar-checker, markdown-editor, markdown-parser, spelling-checker
• Language: TypeScript
• Homepage: https://twhite96.github.io/checkyoself/
• Size: 17.5 MB
• Stars: 41
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Check Yo Self

>  A site to check the grammar of your markdown blog posts/texts.

[![Shields](https://img.shields.io/badge/Status-WIP-%2306d7d9?style=for-the-badge&logo=appveyor)](https://img.shields.io/badge/Status-WIP-%2306d7d9)

[![MIT Licence](https://img.shields.io/github/license/twhite96/checkyoself?style=for-the-badge)](https://opensource.org/licenses/mit-license.php)

[![GitHub commits](https://img.shields.io/github/commits-since/twhite96/checkyoself/0.7?style=for-the-badge)](https://github.com/twhite96/checkyoself/releases/tag/0.7)

![Mastodon Follow](https://img.shields.io/mastodon/follow/109368045337420181?color=%23278bff&domain=https%3A%2F%2Fhachyderm.io&logo=Mastodon&style=for-the-badge)

[Live Demo](https://checkyoself.tiffstuff.dev)

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/twhite96/checkyoself)

---

How to use:

1. 🌀 Clone the repo at `https://github.com/twhite96/checkyoself.git`

2. 🏃 Run: `npm i` to install dependencies.

3. 🎊 Have fun with it.

---

## 💪🏽 Motivation for this app

Frustrated by Grammarly and Hemingway apps' inability to process markdown blog posts, I decided to make my own site to process markdown blog posts or other texts. I settled on React Bulma for the UI because it is lightweight and flexible, like Bulma.

## 🥞 Stack

I am currently using React-Bulma, create-react-app, write-good, and SimpleMDE markdown editor. Eventually I'd like to use Firebase for data persistence.

## 👊🏽 Wins

The components are written for the most part; there are some breaking changes with SimpleMDE editor and so I am not upgrading to the latest version.

I've also become more cognizant of React patterns and concepts.

For instance,

## 😐 Difficulties

Getting the styling was easy. At first, getting the navigation together with the `react-transition-group` library was difficult as I didn't have much experience with React when I started this project for instance, this hamburger button:

```jsx

export default ({ open, ...props }) => (

  


    


    


    


  

);

```


I didn't know what it was doing. What was this line: `{open ? "burger-menu open" : "burger-menu"}` and what did it do?

## 🚶‍♂️Next steps

## ⚡ Refactor ⚡

###  📘 Further reading

## Meta

Distributed under the MIT license. See ``LICENSE`` for more information.

[https://github.com/twhite96/checkyoself](https://github.com/twhite96/checkyoself)