Skip to content

Commit

Permalink
‘项目创建’
Browse files Browse the repository at this point in the history
  • Loading branch information
lizhifuabc committed Sep 4, 2023
0 parents commit dd9d323
Show file tree
Hide file tree
Showing 9 changed files with 1,639 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: docs

on:
# 每当 push 到 main 分支时触发部署
push:
branches: [main]
# 手动触发部署
workflow_dispatch:

jobs:
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
with:
# “最近更新时间” 等 git 日志相关信息,需要拉取全部提交记录
fetch-depth: 0

- name: Setup Node.js
uses: actions/setup-node@v1
with:
# 选择要使用的 node 版本
node-version: '14'

# 缓存 node_modules
- name: Cache dependencies
uses: actions/cache@v2
id: yarn-cache
with:
path: |
**/node_modules
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
# 如果缓存没有命中,安装依赖
- name: Install dependencies
if: steps.yarn-cache.outputs.cache-hit != 'true'
run: yarn --frozen-lockfile

# 运行构建脚本
- name: Build VuePress site
run: yarn docs:build

# 查看 workflow 的文档来获取更多信息
# @see https://github.com/crazy-max/ghaction-github-pages
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v2
with:
# 部署到 gh-pages 分支
target_branch: gh-pages
# 部署目录为 VuePress 的默认输出目录
build_dir: docs/.vuepress/dist
env:
# @see https://docs.github.com/cn/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
GITHUB_TOKEN: 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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
.temp
.cache
9 changes: 9 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module.exports = {
lang: 'zh-CN',
title: '拔土豆的程序员',
description: '不知道咋说,随便写写吧',

themeConfig: {
logo: '/public/images/logo.png',
},
}
Binary file added docs/.vuepress/public/images/favicon.ico
Binary file not shown.
Binary file added docs/.vuepress/public/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
home: true
# Public 文件路径
heroImage: /images/logo.png
actions:
- text: 快速上手 →
link: /zh/guide/getting-started.html
type: primary
- text: 项目简介 →
link: /guide/
type: secondary
features:
- title: 宗旨
details: 三天打鱼,两天晒网。
- title: 目的
details: 心血来潮的时候记录一下,忘记了就算了。
- title: 其他
details: 随便看看得了。
footer: 开开心心 | 平平安安
---
2 changes: 2 additions & 0 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# 指引

14 changes: 14 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "tomato-website",
"version": "1.0.0",
"main": "index.js",
"author": "拔土豆的程序员 <[email protected]>",
"license": "MIT",
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
},
"devDependencies": {
"vuepress": "^2.0.0-beta.67"
}
}
Loading

0 comments on commit dd9d323

Please sign in to comment.