git补充

2 阅读4分钟

gitignore

默认情况下,git会监视项目中的所有内容,但是有些内容比如node_modules,我们不希望把这种文件交给git管理

我们可以在项目目录中添加一个 .gitignore 文件,来设置那些需要git忽略的文件

1.创建.gitignore文件

2.文件里面一行就是一个文件

*.js 表示所有以.js 的文件都不会被监视

#表示注释


gh-pages

github上提供了一个功能,允许我们把我们自己的静态网页直接部署到github上,它会给我们提供域名,我们可以

直接通过域名访问我们的静态网页

要求

静态页面的分支必须叫 gh-pages

怎么部署呢

1.创建新仓库

2. 给分支改名

页面推到github后,点进setting,如果页面是gh-pages,页面左边会多一个pages选项,里面会告诉你通过

哪一个路径访问

如果希望页面可以通过 xxx github.io访问,则需要将我们库的名字修改成xxx github.io

docusaurus简介

是一个Facebook推出的开源、基于react技术栈的静态网站生成器(SSG),主打专业、高性能的文档站建设,也能做博客、官网等。

说白了,就是可以用它快速的搭建一个静态网站,刚好和GitHub契合,一个搭建一个部署

官网使用

首先我还是建议看官网,我的步骤也是跟着官网走的,我这算是一个缩小版的官网

首先,安装 Node.js 并创建一个全新的 Docusaurus 网站:

npx create-docusaurus@latest my-website classic

自动联网下载帮我们创建项目

然后,启动项目

npm start
#或者
yarn start 
#......

这里启动的是我们的开发环境,也就是启动完我们可以随时监视我们项目的修改

截屏2026-04-06 00.21.34

当出现这个网页说明成功了,我们将一步步解读里面的信息

配置项目

解读

docusaurus.config.js 项目的配置文件

 title: 'My Site',
 # 网站的title
 tagline: 'Dinosaurs are cool'
 # My Site 下面那一行
 # 上面两行并无实际意义
 ------------------------------------------------------------------------------------------------------------
 url: 'https://your-docusaurus-site.example.com',
 # 网站根目录,可以自己部署,比如github创建的网站
 baseUrl: '/'
 # 根目录,一般不动,如果你项目还要深一层部署,就写上就行
  favicon: 'img/favicon.ico'
 # 收藏夹的小图标,默认小恐龙,后面是图标路径
 organizationName: 'facebook'
 # 通常是github的用户名
 projectName: 'docusaurus'
 # 仓库名
 i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },
 # i18n 是注释里的internationalization,国际化的意思,单词开头是i,结尾是n,中间有18个字母
 defaultLocale: 'en'
 locales: ['en']
 # 默认是 en 英文,我们可以改成 zh 中文的意思
 # 改成中文后,时间、日期、格式等都变成中文格式
 ------------------------------------------------------------------------------------------------------------
 往后翻很长一段,可以修改footer
 footer:{
 style:
 links: [{}]
 }
 # 里面传了底部的三个对象
 copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`
 # 版权信息

简易的改了基本信息后,我们下一步就是把网站推到github上,直接执行

yarn build
#或者
npm run build
# ......

此时,在你的目录下会多出一个build目录,这个就是把我们刚刚所写的打包成一个静态网站

我们前面配置了url,如果需要往服务器部署,我们得把URL改成自己的域名

手动push到GitHub上有点麻烦,在我们的package.json文件中它给我们提供了功能叫

"deploy": "docusaurus deploy"

所以我们只需要执行yarn deploy

它就会自动把项目部署到git仓库,因为我们前面配置了仓库信息,它默认并不是部署到gh-pages分支

所以我们需要指定分支,在 docusaurus.config.js 中指定分支

deploymentBranch: "gh-pages",

然后我们再进行提交yarn deploy

上传代码时,有两个注意事项

1.deploymentBranch 来指定分支!

2.还需要配置一个环境变量:GIT_USER=github的用户名 yarn deploy

添加页面

在docusaurus框架中,页面分成三种:

1.page (页面)

2.blog (博客)

3.doc (文档)

page

src下有pages

自己怎么创建页面

第一种方式新建文件,文件名就是页面的路径,js的页面是基于react,编写一个react组件即可成为页面,优点灵活,缺点只支持react

import react form "react"
export default () => {
  return <div>
      <h1>第一个页面</h1>
  </div>
}

然后我们 yarn start

我们需要去本地访问项目,因为没有提交,线上的看不见,那我们刚才创建的页面去哪访问

url / 文件名

如果我们想风格和主页一致,可以

import Layout from "@theme/Layout"

然后就可以:

import react form "react"
import Layout from "@theme/Layout"
export default () => {
  return 
  <Layout>
     <div>
        <h1>第一个页面</h1>
     </div>
  </Layout>
}

这样我们项目就带了一个默认的布局

第二种方式新建一个md文件,同样还是文件名会成为路径,访问方式和上一种一样,优点简单,缺点单一,自己抉择


blog

直接用md去写就行了,配置信息

---
slug: first-blog-post
# 文章的地址
title: First Blog Post
authors: [slorber, yangshun]
tags: [hola, docusaurus]
文章标签
---

doc

就和平时看的官网类似,写在docs里,和blog类似


GIt 完结 !