跳到主要内容

网站介绍

功能模块

技术栈

  • React.js 用于构建 web 用户界面的前端开发框架
  • Docusaurus 快速构建以内容为核心的最佳网站
  • MarkDown 编写静态文档页面

本地运行

Node.JS 18+

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

开发指南

目录文件作用
docs课程文档
src/componentsReact 组件代码
src/pagesReact 页面代码
staticReact 页面图片等资源
docusaurus.config.ts项目配置文件
sidebars.ts路由配置文件

添加课程笔记文档

比如第二季添加第一节课程

  1. docs/session2 文件夹下创建 session-2-01.md
  2. 文档顶部添加如下内容
---
sidebar_position: 1
---
  1. 课程页面 第二季:实战开发 目录下即可看到 session-2-01.md 文件对应的文档页面, 并且该页面位于当前目录下第一个。

添加 React 页面

比如在顶部导航栏最后加一个 论坛 页面

  1. src/pages/ 文件夹下创建 forum.tsx ,并编写论坛页面内容
  2. docusaurus.config.ts 文件中 navbar 内找到对应的 items 中添加 {to: '/forum', label: '论坛', position: 'left'},
  3. 即可在顶部导航栏看到论坛导航按钮

未来规划

欢迎大家提出宝贵建议

提示

由于团队需要专注录制视频教程,网站开发方面精力有限。真诚地邀请有志之士加入我们的团队,共同推动网站的开发。

欢迎有兴趣的朋友联系我们。