Are you a developer or writer who often works with GitHub? Then let me introduce you to Ghore, a command-line tool that will change the way you preview your Markdown files before committing them!
Ghore is an open-source tool that simply converts your Markdown files into HTML, perfectly mimicking GitHub’s rendering style. Gone are the days when you had to push your changes just to see what your README.md would look like on GitHub. Now, you can get an instant preview right in your terminal:
- You can use it completely offline. No need for the internet to play around with your Markdown files. You could even use it in an anti-nuclear bunker if you like!
- It automatically monitors changes in your Markdown file and updates the HTML rendering in real-time. It’s like Ghore is reading your mind and anticipating your every modification—both creepy and awesome.
- Do you love colorful and syntactically perfect code blocks? So does Ghore! With the integration of Starry Night, your code blocks have never looked so good. It’s almost a pleasure to read code in the terminal.
- The cherry on top: Ghore supports live previewing of Mermaid code blocks. You know, those super handy diagrams you can make in Markdown? Well, even GitHub’s API doesn’t natively support them, but Ghore does! You’ll be able to impress your colleagues with your interactive diagrams.
In short, using Ghore is super simple. Clone the repository, install the dependencies with npm, and you’re ready to convert your Markdown files in a flash.
git clone https://github.com/p-balu/ghore.git
cd ghore
npm install
npm start your/file/README.mdAnd if you want to customize the HTML rendering, to use neon pink Comic Sans on a green background, go ahead, no one will judge you (well, almost no one)! Ghore comes with its own CSS file that you can tweak to your heart’s content.
See you soon on Tech To Geek.
