Markgit NPM | npm.io

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.

   <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>

   <script>
     	const mg = MarkGit
   </script>

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)
       )

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)
       )

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)
       )

Install using npm npm i markgit

Import/Require markgit

   const mg = reqiure('markgit');

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

1 year ago

1 year ago

1 year ago