首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

在Docusaurus v2文档中嵌入GitHub要点

在Docusaurus v2文档中嵌入GitHub的要点是通过使用Docusaurus提供的插件和配置来实现。以下是具体的步骤和要点:

  1. 配置GitHub仓库:首先,确保你有一个GitHub仓库用于存储你的文档。在仓库中创建一个用于存放文档的文件夹,例如"docs"。
  2. 安装Docusaurus插件:在你的Docusaurus项目中,使用npm或yarn安装@docusaurus/plugin-content-docs插件。
  3. 配置文档源:在Docusaurus项目的docusaurus.config.js文件中,找到presets部分,并添加以下配置:
代码语言:txt
复制
module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          path: 'docs',
          sidebarPath: require.resolve('./sidebars.js'),
          // 其他配置项
        },
        // 其他preset配置项
      },
    ],
  ],
};

其中,path指定了文档文件夹的路径,sidebarPath指定了侧边栏配置文件的路径。

  1. 配置侧边栏:在Docusaurus项目的根目录下创建一个sidebars.js文件,并添加以下配置:
代码语言:txt
复制
module.exports = {
  docs: [
    {
      type: 'category',
      label: '文档',
      items: [
        'doc1',
        'doc2',
        // 其他文档页面
      ],
    },
  ],
};

items数组中添加你的文档页面的文件名。

  1. 编写文档:在之前创建的文档文件夹中编写你的文档,可以使用Markdown或MDX格式。
  2. 部署文档:使用Docusaurus提供的命令将你的文档部署到GitHub Pages或其他托管平台上。

通过以上步骤,你就可以在Docusaurus v2文档中成功嵌入GitHub仓库中的文档内容了。

对于Docusaurus v2的更多详细信息和配置选项,你可以参考腾讯云提供的Docusaurus v2文档

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

PNPM monorepo docs package部署成Github Page

前言 最近需要把一个前端工程转交出去给其他小伙伴接手; 因为一直在内部孵化,基本除了少数维护的几个人可能知根知底; 而对于其他人来说一片空白,所以需要提供一个文档体系来辅助别人上手; 文档维护采用docusaurus...来搭建,代码Github,所以想把Github Page利用起来; 又因为采用monorepo子包的方式维护,看了下社区没有相关部署姿势,就写了这么一篇; 效果图 Github Action 执行过程...文档存放及部署分支 访问效果 工程信息 依赖采用PNPM v8来统一管理 monorepo机制也是采用pnpm默认提供的 文档不是根目录(比如docs目录这种),是当做一个monorepo package...来维护,如图 需要解决问题 因为我们把文档做成一个monorepo 子包来维护了,所以对应的产物也包内; 常规的Github Page只能读取工程根目录或者根目录下的docs文件夹,此时就没法直接通用了...,如下图所示; 翻了翻【docusaurus deployment】官方的部署文档的指南,发现并没有针对monorepo的指导; 但是办法总比困难多,知道了Github Page的部署机制,其实就有法子绕过去了

48120

使用docusaurus快速搭建静态博客站点

它提供了开箱即用的文档功能,但可以用来创建任何类型的网站(个人网站、产品、博客、营销登陆页面等)。 <!.../blog目录,要添加博客,只需要在这个目录写markdown文档,非常方便。 ..../blog目录已经存在一些文件,它们是官方给出的模板,可以看看了解博客md的书写格式,后面如果不需要这些文件,可以把它们全部删除。 ....--truncate-->用于显示概要,该标签之前书写概要,之后书写具体内容。对应的,博客列表中会有一个"Read More"按钮,点击这个按钮会从博客列表页进入博客详情页。...发布站点之前,需要先打包,执行如下命令: yarn build 打包完毕后,可以.

1.2K70

静态网站生成器推荐:构建高性能网站的利器

简单易上手:Docusaurus 的设计目标是让用户能够最短时间内快速搭建起自己的网站,它处理了大部分网站构建过程,使您可以专注于项目本身。...可本地化:Docusaurus 支持通过 CrowdIn 进行多语言支持。通过将文档进行翻译,您可以扩展并发展国际社区。...可定制化:Docusaurus 不仅提供了主页、文档页面、博客以及其他辅助页面等关键功能模块来帮助你开始使用,在此基础上也提供了丰富的可定制选项,确保每个人都拥有与众不同的网站。...可以连接任何 CMS 或数据源,包括 WordPress、Contentful 等,并使用 GraphQL 页面和组件访问数据。...只需几分钟即可完成整个建立过程;由于 Pubii 是一个桌面应用程序,没有网络连接时仍然可以离线创建更新修改你想要展示到互联网的信息。

54520

打造个人IP: 开源项目网站构建框架

流行文化,我们经常听到新闻博客或名人博客网站,但正如您将在本指南中看到的那样,您可以创建一个关于任何可以想象的主题的成功博客。 博主通常从个人角度撰写,允许他们直接与读者联系。...我的博客修改自该主题:hexo-theme-Next Docusaurus 官方地址: https://docusaurus.io/ 背书: 撰写文章此时github星数: 11815 Docusaurus...Docusaurus有以下优点: Markdown驱动-节省时间并专注于项目的文档。...重复使用相同的页眉和页脚时,可以扩展Docusaurus。 本地化已 预先配置。使用Crowdin将您的文档翻译成70多种语言。 让您的社区轻松找到他们文档中所需的内容。...支持Algolia文档搜索。 HUGO 官方地址: https://hexo.io/ 背书: 撰写文章此时github星数: 35195 Hugo是最受欢迎的开源静态站点生成器之一。

1.5K40

VuePress vs Docusaurus:开源API文档工具的终极对决

亲爱的CodeIdea读者朋友们,欢迎来到这场开源API文档工具的终极对决。软件开发的世界里,好的文档是不可或缺的,而选择适合您的API文档工具可能是一个关键决策。...本文中,我们将深入比较两款热门的开源API文档工具:VuePress和Docusaurus。 为什么选择API文档工具? 软件开发,好的API文档对于开发人员、团队协作和项目的成功至关重要。...快速生成:由于是静态网站生成器,VuePress生成的文档非常快速,适用于快速查阅和搜索。 SEO友好:VuePress具有出色的SEO性能,可确保您的文档搜索引擎获得良好的排名。...Docusaurus:Facebook背书的文档工具 Docusaurus简介 Docusaurus是由Facebook开发并维护的文档工具,旨在创建美观、易于维护的文档网站。...它被广泛用于开源项目和公司文档Docusaurus的优势 易于上手:Docusaurus提供了简单的配置和Markdown编写文档,适用于不同技能水平的开发者。

1.2K60

Docusaurus VS VuePress:哪一个更适合你的技术文档

在当今的开发世界,高质量的技术文档对于项目的成功至关重要。好的文档不仅能帮助开发者快速上手,还能大大提升项目的易用性和维护性。...什么是DocusaurusDocusaurus是Facebook开发的一个静态网站生成器,专注于构建优美的文档网站。它基于React,设计初衷是为开源项目提供一个高效、简洁的文档解决方案。...VuePress支持Vue组件,可以Markdown中直接使用Vue的功能,适合熟悉Vue生态的开发者。 3....这些网站界面简洁、功能完善,体现了Docusaurus大型项目中的应用优势。...希望本文的对比分析能帮助你做出明智的选择,为你的项目找到最合适的文档生成工具。如果你有更多问题或经验分享,欢迎评论区留言讨论。

1100

2018年1月份最热门的JavaScript开源项目

它会将你 Webpack 构建开发和生产过程的所有相关信息都放到浏览器。 JARVIS 非常漂亮,可显示导入的 ES Harmony 模块的数量,以及资产 12 种不同的连接类型的表现。...浏览器手动完成的大多数事情都可以通过使用 Puppeteer 完成,如生成屏幕截图和 PDF 页面、检索 SPA 并生成预渲染内容(即“SSR”)、从网站上爬取内容等 九、静态网站建站工具 Docusaurus...构建一个带有主页、文档、API、帮助以及博客页面的静态网站,只需5分钟。 ● 启动简单 :Docusaurus的构建可以很短的时间内启动和运行。...Docusaurus已经构建了处理网站的过程,开发人员只需专注于项目。 ● 本地化: Docusaurus 通过CrowdIn 提供本地化支持。通过翻译文档增强国际社区的地位。...● 可自定义:Docusaurus 可自定义项目需要的关键页面,包括主页,文档部分,博客和其他页面 十、JavaScript 运动引擎 Popmotion https://github.com/Popmotion

2.1K80

一日一技:不走常规路线,列表页1秒抓取

然后你会发现,目录每一项的URL是一个js文件的: Docusaurus还比较简单。...它的URL是分散很多JS文件的,解析起来非常麻烦。 遇到这种网站怎么快速获取目录页的所有URL呢?其实不需要使用任何高级工具就能解决。...对于Docusaurus[3],我们只需要在它的域名后面加上/sitemap.xml,然后搜索关键词/docs/,就可以找到所有的文档URL,如下图所示: 由于Docusaurus是一个用来生成文档的框架...,所以理论上所有使用Docusaurus生成的文档,都可以通过这个方法获得所有文档页面的URL。...同理,对于Uniswap Docs这个网站,域名后面加上/sitemap.xml,然后搜索关键词/concepts就可以找到所有文档页面的URL,如下图所示: 这两个例子是想告诉大家,拿到一个爬虫任务的时候

21430

为什么选择Docusaurus构建API文档

现代化软件开发文档对于软件成功的重要性不言而喻。然而,管理和维护文档站点往往会给开发者带来额外的负担。为了帮助开发人员快速构建易于管理和维护的文档站点,Docusaurus应运而生。...本文将深入探讨为什么选择Docusaurus构建您的文档站点是一个好的选择。 Docusaurus是什么?...Docusaurus是由Facebook开发的,最初是为React Native文档而创建的。现在,Docusaurus已经成为开发者创建和维护文档站点时的首选工具之一。...它提供了一套现成的模板和主题,让开发者可以快速开始构建文档站点。另外,Docusaurus还提供了一个实时预览功能,让开发者可以本地进行修改和调试,从而加快开发效率。...通过使用Docusaurus,您可以专注于文档内容本身,而无需为文档站点的管理和维护担忧。

68020

React 新官网发布,开发文档更全面更易用

新版开发文档的特点 新版开发文档是基于 Docusaurus 2.0 来构建的,相比于之前的版本,有以下几个特点: 更快的页面加载速度:Docusaurus 2.0 使用了预渲染技术,将 MDX 和 React...更美观的页面设计:Docusaurus 2.0 提供了多种内置主题和插件,让你可以轻松地定制你的网站外观。你也可以使用 CSS 模块或者样式组件来编写自己的样式。...新版开发文档的内容 新版开发文档不仅使用了 Docusaurus 的最新技术,还对内容进行了重新组织和更新。...你可以文档中找到以下内容: 入门指南:教你如何在不同场景下使用 React ,包括 HTML 页面添加 React ,创建一个新的 React 应用,以及学习 React 的基本概念。...总结 React 新版官网是一个值得关注和学习的项目,不仅展示了 React 的强大功能和优雅设计,还展示了 Docusaurus 的灵活性和易用性。

46540

博客生成静态站点工具 Top 20

你可以查看它的 GitHub和官网了解更多。 6.Docusaurus star 数 42K+。 Docusaurus 是一个有趣的开源静态网站生成工具,为搭建文档类网站量身定制。...Docusaurus 是用 React 构建的。你可以使用所有的基本功能,像文档版本管理、文档搜索和翻译大多是预先配置的。...如果你想为你的产品或服务搭建一个文档网站,那么可以试试 Docusaurus。 你可以查看它的 GitHub和官网了解更多。 7.Hexo star 数 35K+。...本文列出了最受欢迎的 Top20 博客静态站点生成工具,它们 GitHub 上的 star 数可以直接反映它们的受欢迎程度。...这些工具的大多数都支持 Markdown 等轻量级格式,并提供了许多主题和插件,可以方便地创建漂亮的博客。此外,这些工具也有很好的文档和社区支持,使得学习和使用它们变得更加容易。

3.2K21

手动给docusaurus添加一个搜索

新版博客用docusaurus重构已经有些日子了,根据docusaurus文档上也申请了Algolia,想一劳永逸的解决博客的搜索问题。但是流水有意,落花无情。...正常情况的申请 按照docusaurus官方文档上说的,当我们需要搜索的时候,打开https://docsearch.algolia.com/apply/填一下申请,提交就行了。...我仔细检查了它的官方文档,看他的描述说是需要等待2个星期。但是2个星期实在太久了,我们只争朝夕的今天,怎么行。 还好,我看到它还有一种手动上传的办法,笨是笨了点,总比没有的好。那就开始吧。...但是docusaurus V3版本已经发生了变化。...回到网站上看看,已经有数据上传上来了: 好了,我们docusaurus.config.ts配置一下,看看效果: algolia: { // The application ID provided

9020

社区生态如何让React做大做强,再创辉煌

「Mark Zuckerberg」宣称[2]: 过分押注H5是FB转型移动优先过程犯过的最大错误 在这样的背景下,「Chedeau」「FB」的同事「Jordan Walke」发明了React。...React团队成员发现:在此过程对React的改造同样适用于其他开发者。于是以此为契机,于次年(13年)将React开源。...将重心放在辅助社区生态建设方面,比如: 开源jest[3](测试框架) 开源docusaurus[4](文档网站管理系统) 而业务开发必需的模块则交由社区自由探索。...「分享」「点赞」「在看」是最大支持 参考资料 [1] React’s greatest power may lie in its open source ecosystem: https://github.com.../facebook/jest [4] docusaurus: https://github.com/facebook/docusaurus [5] Vercel: https://vercel.com/

53320

用vuepress2搭建自己的github网站

一、根据官方示例搭建项目直接根据官方文档先初始化项目就行了,注意文档的版本,v1和v2还是有很多地方不同的。...工具的部署,vuepress文档上也有写,我们这里选择用 GitHub Actions 部署到 GitHub Pages,根据步骤直接操作就行了,需要注意的几个地方:1、官方提供的GitHub Actions...2、文档上写的项目自动生成的打包命令是:yarn docs:dev和yarn docs:build,实际使用我们往往会直接改成 yarn dev和yarn build,如果改了GitHub Actions...四、vuepress v2版本的坑最新的v2版本和v1有很大的不同,网上大部分的教程都是针对v1版的,v2并不起作用。1....,vue3的官方文档上也有介绍: Vite 是一个 web 开发构建工具,由于其原生 ES 模块导入方式,可以实现闪电般的冷服务器启动3. markdown中使用vue组件v2版本像v1所谓的“主题目录结构约定

31810

用vuepress2搭建自己的github网站

一、根据官方示例搭建项目 直接根据官方文档先初始化项目就行了,注意文档的版本,v1和v2还是有很多地方不同的。...CI工具的部署,vuepress文档上也有写,我们这里选择用 GitHub Actions 部署到 GitHub Pages,根据步骤直接操作就行了,需要注意的几个地方: 1、官方提供的GitHub Actions...2、文档上写的项目自动生成的打包命令是:yarn docs:dev和yarn docs:build,实际使用我们往往会直接改成 yarn dev和yarn build,如果改了GitHub Actions...四、vuepress v2版本的坑 最新的v2版本和v1有很大的不同,网上大部分的教程都是针对v1版的,v2并不起作用。 1....,vue3的官方文档上也有介绍: Vite 是一个 web 开发构建工具,由于其原生 ES 模块导入方式,可以实现闪电般的冷服务器启动 3. markdown中使用vue组件 v2版本像v1所谓的“主题目录结构约定

32640
领券