LiveTerm 是一个基于 Next.js 的高度可定制、易于使用的简约的终端风格网站模板,只需几分钟,就能创建一个命令风格网站,只需编辑一个文件:config.json
。
LiveTerm 需要使用 yarn 包管理器,在终端中运行以下命令:
sh -c "$(curl -fsSL https://raw.github.com/Cveinnt/LiveTerm/main/install/install.sh)"
把 LiveTerm 安装到当前目录,然后进入项目文件夹并启动开发服务器:
cd LiveTerm && yarn dev
开始编辑 config.json
文件,保存后就能看到更新的变化。
可以将此仓库克隆到你选择的位置:
git clone https://github.com/Cveinnt/LiveTerm.git && cd LiveTerm
然后安装依赖并开始开发:
yarn install && yarn dev
Docker 使用
克隆项目并编辑 config.json
,运行以下命令在后台启动容器:
docker-compose up -d
如果你熟悉相关操作,可以修改 Dockerfile
和 docker-compose.yml
文件。
基本配置
LiveTerm 的大部分配置都是通过 config.json
文件完成的:
{
"readmeUrl": "创建一个 Github README 并在此链接!",
"title": "网站的标题",
"name": "你的名字,包含在 'about' 命令中",
"ascii": "要显示的 ASCII 艺术字",
"social": {
"github": "你的 GitHub 用户名",
"linkedin": "你的 LinkedIn 用户名"
},
"email": "你的邮箱",
"ps1_hostname": "liveterm",
"ps1_username": "visitor",
"resume_url": "../resume.pdf",
"non_terminal_url": "W",
"colors": {
"light": { ... },
"dark": { ... }
}
}
你可以根据自己的需求随意更改这些配置!
主题
可以在 themes.json
中找到几个预配置的主题,可以将 config.json
中的颜色替换为你喜欢的主题颜色,这些主题基于某个网站上的主题。
网站图标
网站图标位于 public/
文件夹中,可以将其他想要上传到网站的文件也放在这里。
横幅
如果你想更改横幅命令的输出,只需将生成的横幅粘贴到 src/utils/bin/commands.ts
文件中。
部署
使用 Vercel 平台部署 Next.js 应用是最简单的方式,可以安装 vercel CLI 并按照说明操作,也可以将 Github 账户连接到 vercel,让 vercel 自动部署 Github 仓库。