Skip to content

Commit

Permalink
update: readme更新
Browse files Browse the repository at this point in the history
  • Loading branch information
Eterance committed Sep 10, 2023
1 parent 9df003d commit 9718695
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ jobs:
run: |
find ./site -type f -name "*.html" -exec sed -i 's|"/|"/web-toolbox/|g' {} +
find ./site -type f -name "*.html" -exec sed -i 's|\.html||g' {} +
# https://stackoverflow.com/a/61560798
- name: Echo the combined string
run: echo "/${GITHUB_REPOSITORY#*/}"
shell: bash
Expand Down
25 changes: 25 additions & 0 deletions readme.en-us.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Eterance Web Toolbox

[简体中文](https://github.com/Eterance/web-toolbox/blob/main/readme.md) | [繁體中文](https://github.com/Eterance/web-toolbox/blob/main/readme.zh-tw.md) | English

## What is this?

This is a web-based toolbox that contains some useful small tools.

This is a purely static website handcrafted with HTML+CSS+JavaScript, with support for mobile view, multiple languages, and light/dark mode.

## URLs

Cloudflare Pages: [https://tools.eterance.com/](https://tools.eterance.com/) (Recommended)

Github Pages: [https://eterance.github.io/web-toolbox/](https://eterance.github.io/web-toolbox/)

For instructions on deploying with Cloudflare Pages, refer to: [https://blog.eterance.com/articles/deploying-a-static-website-with-github-action-and-cloudflare-pages/](https://blog.eterance.com/articles/deploying-a-static-website-with-github-action-and-cloudflare-pages/) (Simplified Chinese only)

## What do I need to modify if I want to deploy this toolbox on my own?

- The icons in all HTML files
- The `<title>` tags in all HTML files
- The `projectName` field in `.github/workflows/deploy.yml` if you want to use Cloudflare Pages
- The website title in `navbar.js` for all languages in `site/components/`, and the project links in `footer.js` and `footer-cf.js` (if you have forked the project)
- Modify the CDN links
4 changes: 3 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Eterance 的百宝箱 (web-toolbox)

简体中文 | [繁體中文](https://github.com/Eterance/web-toolbox/blob/main/readme.zh-tw.md) | [English](https://github.com/Eterance/web-toolbox/blob/main/readme.en-us.md)

## 这是什么?

这是一个网页版的工具箱,包含了一些有用的小工具。

这是一个徒手撸的 HTML+CSS+JavaScript 的纯静态网站。
这是一个徒手撸的 HTML+CSS+JavaScript 的纯静态网站,适配移动端视图、多语言、支持亮暗模式

## 网址

Expand Down
26 changes: 26 additions & 0 deletions readme.zh-tw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Eterance 的百寶箱 (web-toolbox)

[简体中文](https://github.com/Eterance/web-toolbox/blob/main/readme.md) | 繁體中文 | [English](https://github.com/Eterance/web-toolbox/blob/main/readme.en-us.md)

## 這是什麼?

這是一個網頁版的工具箱,包含了一些有用的小工具。

這是一個徒手撸的 HTML+CSS+JavaScript 的純靜態網站,適配移動端視圖、多語言、支持亮暗模式。

## 網址

Cloudflare Pages:[https://tools.eterance.com/](https://tools.eterance.com/) (推薦)

Github Pages:[https://eterance.github.io/web-toolbox/](https://eterance.github.io/web-toolbox/)

如何部署在 Cloudflare Pages 參見:[https://blog.eterance.com/articles/deploying-a-static-website-with-github-action-and-cloudflare-pages/](https://blog.eterance.com/articles/deploying-a-static-website-with-github-action-and-cloudflare-pages/)(僅提供簡體中文)

## 如果我要自行部署這個工具箱,要修改什麼地方才能把它變成我的?

- 所有 HTML 文件中的 icon
- 所有 HTML 文件中的 `<title>` 標籤
- 如果你要使用 Cloudflare Pages,`.github/workflows/deploy.yml` 中的 `projectName` 欄位
- `site/components/` 中所有語言的 `navbar.js` 的網站標題、(如果 folk 了項目)`footer.js``footer-cf.js` 的項目連結
- 修改連結的CDN
-
1 change: 1 addition & 0 deletions site/js/main.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

const darkModeToggle = document.getElementById('darkModeToggle');
const body = document.body;
// 该占位符将在 Github Actions 中被替换为实际的项目名称
const githubProjectName = "<ProjectNamePlaceHolder>";

// 检查本地存储中的模式设置
Expand Down

0 comments on commit 9718695

Please sign in to comment.