# WHY 为什么使用docusaurus? - 开发文档完全，20%README，80%Documentation - 搜索功能 - 兼容很多开发语言的version - Markdown写作&MDX jsx into markdown - react components in your markdown - react pages # WHAT Docusaurus是一个静态网站生成器。它使用[[🗃️ 卡片盒子/110 - 前端开发/Docusaurus/React]]的全部功能构建单页应用程序，实现快速客户端导航，使您的网站具有交互性。它提供开箱即用的文档功能，但也可以用于创建任何类型的网站（个人网站、产品、博客、营销着陆页等）。 # HOW [官方视频教程]([(621) Docusaurus: Documentation Made Easy - YouTube](https://www.youtube.com/watch?v=Yhyx7otSksg)) - check docusaurus的版本，可使用最新 - 安装nvm：可切换node.js版本 - 下载网站框架 [[安装与本地预览]] - [ ] 本地启动网站 - [[pages 修改首页|修改首页banner和主体部分的布局与内容]] - 修改首页 - 在[[Docusaurus 配置文件#^233bfb]]的主题配置中修改首页导航栏信息 - 搭建网站二级页面框架 - [[Docusaurus 侧边栏Sidebar#^91c7db|导航栏链接侧边栏]] - 删除blog文件夹和config.js中的blog相关代码 - 将Obsidian推送到GitHub：[[Obsidian Git]] - 上传网站源代码至GitHub（上传本地文件夹到方法） - *7.02 需要删除重新上传，obsidian仓库出现上传错误，重新推送GitHub后要看下是否能够正常同步？目前观察是obsidian git插件不行，GitHub desktop可以* - 通过添加子模块如何将obsidian的GitHub仓库连接到网站的GitHub仓库下[[Git submodule 子模块]] - **新问题：md文件格式不符合**[[Obsidian在Docusaurus的md规范问题]] - [[部署到GitHub Pages]] - 如何通过GitHub Action工作流触发自动同步 - 创建doc页面：默认界面有2个导航，docs和blogs - [ ] 创建markdown页面 - [ ] 创建[[mdx1]]页面 - 创建blog页面 # HOW GOOD - 了解[[文件夹结构]] - 了解操作命令 ![[CleanShot 2023-05-13 at [email protected]]] # inbox # todo - 什么是node.js？ - 什么是JSON？ # archive # ref. --- 官方视频教程 - [ ] 打开网站的Docs - [ ] 可以在GitHub上修改页面内容（如果将GitHub作为网站托管的话） ![[CleanShot 2023-05-13 at [email protected]]] - [ ] 安装search - [ ] v2 使用插件（plug-in）架构 14‘ - [ ] 打开 docusaurus.config.js - [ ] 在一级文件夹中创建文件夹：monitoring-plugin - youtube教程：https://www.youtube.com/watch?v=I-hYKNgaMmE&t=261s - 官方sidebar文件：![[sidebars.js]] - 官方config.js文件![[docusaurus.config.js]] ### 案例 - [1password](https://developer.1password.com/docs/cli/shell-plugins/github/)