简介
npm是node.js中的包管理工具，拥有着海量的开源包。oh-my-github-viewer-default是一个优秀的npm包，它可以将github仓库的readme文件渲染到网页上，方便我们在浏览器中阅读，它不仅能够使我们更方便地查看readme文件，而且这个包的代码也易于理解，有助于我们学习有关npm包的开发。
在这篇文章中，我们将学习如何使用oh-my-github-viewer-default npm包，并深入了解它的实现细节，为您的学习和使用提供更好的指导。
安装
如果您使用npm 5.2及以上版本，则可以直接使用以下命令安装oh-my-github-viewer-default。
npm i oh-my-github-viewer-default
如果您使用的是较老版本的npm，则需要加上 --save选项才能将其添加到你的项目中。
npm i oh-my-github-viewer-default --save
使用指南
要使用oh-my-github-viewer-default，只需要在您的项目中导入该包并调用其中的函数即可。例如：
import omgv from 'oh-my-github-viewer-default'
const render = async () => {
const markdown = await omgv.getReadme({ user: 'github_user_name', repo: 'github_repo_name' })
document.getElementById('readme').innerHTML = markdown
}
render()这个例子中，我们先导入oh-my-github-viewer-default包，然后通过调用getReadme函数使用它。getReadme函数接收一个对象作为参数，该对象包含由github_user_name和github_repo_name组成的键值对，表示从哪个Github存储库获取Readme。
执行getReadme函数后，会返回一个包含Markdown格式的Readme，这个例子将这个Readme渲染到id为readme的页面元素中。
原理
oh-my-github-viewer-default的工作原理非常简单：它通过GitHub API下载指定存储库的readme文件，并将其推送到一个Markdown格式解析器中。解析器将字符串转换为HTML并返回给调用者。
具体来说，它利用axios向Github API发出网络请求，获取readme文件的内容。然后，它使用一个名为Showdown的库来解析Markdown，并将解析结果返回到用户界面。Showdown是一种客户端JavaScript库，用于将Markdown格式的文档转换为HTML，它支持从Markdown格式转换为HTML的所有标准语法。
在这个过程中，oh-my-github-viewer-default还保留了所有Markdown元素的上下文信息。例如，它能够识别所有列表，标题，段落等，同时保留它们的结构。这也是oh-my-github-viewer-default所做的全部内容。因此学习和使用oh-my-github-viewer-default不仅可以帮助您快速实现一个将Markdown文档转换为HTML文档的功能，而且可以帮助您更深入地理解网页开发。
结语
本文介绍了oh-my-github-viewer-default npm包的使用方法，同时也详细解释了它的原理。oh-my-github-viewer-default是一个强大的工具，它可以帮助我们快速地渲染GitHub存储库的Readme文件到我们的网站中。而且，因为它使用的是几个众所周知的技术，使用它还可以加深您对前端技术的理解。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f9e3d1de16d83a670c9