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
Maintainers
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
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 withstatus
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 withstatus
,content_markdown
andcontent_html
key.
MarkGit.getContent(username,reponame,filename/filepath).then(
data => console.log(data)
)
search
-> Search For Markdown File in a Repo viaKeyword
. It reqiures three parameter as string, Search Keyword , Github Username and the name of the Repo . It returns an Array Object withstatus
,total_count
and an Array containing matched files withfilename
andfile_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.