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

markgit

v1.0.3

Published

Use Github Repo as a Public Database to Store Markdown Files. Retrieve the Files in HTML Format. Get the List of Markdown Files From a Repo

Downloads

5

Readme

markgit

Use Github Repo as a Public Database to Store Markdown Files. Retrieve the Files in HTML Format. Get the List of Markdown Files From a Repo.

Usage

Include the script tag in the <head> section.

   <script src="https://raw.githubusercontent.com/Sidmaz666/markgit/main/dist/markgit.js"></script> 

Or Download the markgit.js file from the dist folder and add it locally.

   <script src="./dist/markgit.js"></script> 

Initiate MarkGit in the <script> within <head> section.

   <script>
     	const mg = MarkGit
   </script>

Available Methods

  1. getList -> List the Markdown .md Files in a Repo. It reqiures two parameter as string, Github Username and the name of the Repo, Optionally it accepts a third parameter for any sub-folder in the repo. It returns an Array. Within the Array an Object with status key.
      MarkGit.getList(username,reponame,sub_folder_name).then(
	data => console.log(data)
       )
  1. getContent -> Get Conetnt of the Markdown .md File in a Repo. It reqiures three parameter as string, Github Username , the name of the Repo and the File Name or Path. It returns an Object with status, content_markdown and content_html key.
      MarkGit.getContent(username,reponame,filename/filepath).then(
	data => console.log(data)
       )
  1. search -> Search For Markdown File in a Repo via Keyword. It reqiures three parameter as string, Search Keyword , Github Username and the name of the Repo . It returns an Array Object with status, total_count and an Array containing matched files with filename and file_path.
      MarkGit.search(search_keyword,username,reponame).then(
	data => console.log(data)
       )

Use With npm in React, Vue, Angular

Install using npm npm i markgit

Import/Require markgit

   const mg = reqiure('markgit');

Note

Since atob function is not available in nodejs (requires for base64 encoding/decoding), markgit is only supported in the browser.