当前位置: 首页 > news >正文

Create Deploy Your Website Quickly - Docusaurus GitHub Pages

在这里插入图片描述

文章目录

    • 1. 简介
    • 2. 准备
    • 3. 创建项目
    • 4. 问题
      • 4.1 GIT_USER=Ghostwritten yarn deploy 卡住

1. 简介

Docusaurus 是一个开源框架,用于快速构建、部署和托管技术文档。它支持 Markdown 格式,提供了主题和插件,支持版本控制,适合开发者编写和托管项目文档。在这篇博客中,我们将介绍如何本地安装 Docusaurus 并将其托管到 GitHub Pages 上。

2. 准备

本地安装 Docusaurus请参考:

  • Npm Install Docusaurus Demo

或者参考官网:https://docusaurus.io/docs

安装npm git 工具参考:https://blog.csdn.net/xixihahalelehehe/article/details/138565544

3. 创建项目

  • github创建 demo 项目。
  • 本地vscode 终端执行:npx create-docusaurus@latest demo classic

安装依赖包。

$ cd demo
$ npm i

配置docusaurus.config.js文件

  url: 'https://github.com',
  baseUrl: '/demo/',
  organizationName: 'Ghostwritten', // Usually your GitHub org/user name.
  projectName: 'demo', // Usually your repo name.
  deploymentBranch: 'gh-pages',

本地启动测试

npm start

访问http://localhost:3000

推送代码至仓库

git init
git add .
git commit -m "website demo"
git branch -M main
git remote add origin https://github.com/Ghostwritten/demo.git
git push -u origin main

触发部署到github托管服务。

GIT_USER=Ghostwritten yarn deploy

调试输出执行:

Edit
GIT_TRACE=1 GIT_CURL_VERBOSE=1 GIT_USER=Ghostwritten yarn deploy

访问:https://ghostwritten.github.io/demo

4. 问题

4.1 GIT_USER=Ghostwritten yarn deploy 卡住

认证github问题,创建token

禁用 VS Code 的 askpass 脚本
你可以临时取消 GIT_ASKPASS 环境变量的设置,让 Git 使用标准终端提示来输入密码。执行下面的命令后再运行部署命令:

unset GIT_ASKPASS

使用 GitHub 个人访问令牌(PAT)
由于 GitHub 已经不再支持使用账户密码进行认证,建议生成一个个人访问令牌,并在提示输入密码时用令牌替换:

  • 登录 GitHub,进入 Settings > Developer settings > Personal access tokens
  • 生成一个新令牌,确保勾选了 repo 等相关权限。
  • 在终端提示输入密码时,粘贴你的令牌即可

GIT_USER=Ghostwritten yarn deploy 执行后,交互输入新生成的token。

相关文章:

  • 2.14学习记录
  • 28、深度学习-自学之路-NLP自然语言处理-做一个完形填空,让机器学习更多的内容程序展示
  • DeepSeek 引领AI新潮流:Janus-Pro 打破多模态理解与生成的边界
  • 探索Hugging Face:开源AI社区的核心工具与应用实践
  • 【Xposed】在 Android Studio 中使用 Kotlin DSL 自动结束并启动应用进程
  • Zabbix告警队列清理教程
  • JUC并发—Java集合包底层源码剖析
  • 麒麟系统离线安装SVN
  • 【Elasticsearch】Elasticsearch检索方式全解析:从基础到实战(一)
  • [css] 黑白主题切换
  • poetry shell - 作为插件安装和使用
  • Django开发入门 – 5. Web框架与MVT架构
  • 手写数字识别学习记录(自用)
  • 在nodejs中使用RabbitMQ(二)发布订阅
  • Python实现文件夹监控:自动捕获并处理新增Excel文件,支持子文件夹遍历
  • AI赋能铁道安全巡检探索智能巡检新时代,基于YOLOv5全系列【n/s/m/l/x】参数模型开发构建铁路轨道场景下轨道上人员行为异常检测预警系统
  • 高中物理-基础知识1
  • 【3.Git与Github的历史和区别】
  • Spring Boot 原理分析
  • 打靶记录29——dawn
  • 复旦建校120周年大型义诊举行,百余名专家服务市民超三千人次
  • 视频丨歼-10CE首次实战大放异彩
  • 北京韩美林艺术馆党支部书记郭莹病逝,终年40岁
  • 多个“首次”!上市公司重大资产重组新规落地
  • 浙江省委金融办原副主任潘广恩被“双开”
  • 侵害孩子者,必严惩不贷!3名性侵害未成年人罪犯被执行死刑