npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ghore

v1.0.6

Published

"An offline package which gives you a preview of Github markdown before commiting"

Downloads

16

Readme

Hey, I am currently open to new work opportunities, you can find my resume here

Ghore (GitHub offline renderer)

alt text

Content

What is this?

Ghore is an open-source, offline command-line interface (CLI) tool specifically designed for developers and writers working with GitHub. Its primary function is to render Markdown files into HTML, closely emulating the GitHub Markdown style. This enables users to preview how their Markdown documents will look on GitHub before committing them to a repository.

Features

  • Offline Conversion: Convert Markdown files to HTML offline without the need for an internet connection.
  • Watch for Changes: Automatically update the HTML output when changes are made to the input Markdown file.
  • GitHub Styling: HTML output mirrors the GitHub Markdown style for consistency.
  • Code Block Highlighting: Integrated Starry Night ensures beautiful and syntax-highlighted code blocks.
  • Flowchart Support: It also supports live preview of mermaid code blocks (Github's API doesn't process mermaid codeblocks).

Examples

Highlights the below code block function using integrated Starry Night

    ```sh
    // Highlight code blocks function
const highlightCode = async (lang, str) => {
  if (!starryNight || !toHtml) {
    await initializeStarryNight();
  }
    ```

like this

const highlightCode = async (lang, str) => {
  if (!starryNight || !toHtml) {
    await initializeStarryNight();
  }

Below mermaid block will be displayed

```mermaid
gitGraph:
    commit "test"
    branch newbranch
    checkout newbranch
    commit id:"1111"
    commit tag:"test"
    checkout main
    commit type: HIGHLIGHT
    commit
    merge newbranch
    commit
    branch b2
    commit
```

like this

gitGraph:
    commit "changes"
    branch newbranch
    checkout newbranch
    commit id:"1111"
    commit tag:"test"
    checkout main
    commit type: HIGHLIGHT
    commit
    merge newbranch
    commit
    branch b2
    commit

Requirements

Requires the latest version of nodejs 20.10.0 or above.

Installation

# Clone the repository
git clone https://github.com/p-balu/ghore.git

# Navigate to the project directory
cd ghore

# Install dependencies
npm install

#To start the application locally
npm start `your/filepath/README.md`

Installing package using npm globally

Install the package globally

npm i ghore -g

Start the application in 2 different ways

If you are already inside the directory where README.md file exists then run

ghore preview

or

ghore preview /path/toyour/README.md

Configuration

You can customize the appearance of the HTML output by modifying the included CSS file (styles.css).

Contributing

Contributions are welcome! Feel free to open issues, submit pull requests, or provide feedback.

License

This project is licensed under the MIT License.