diff --git a/README.MD b/README.MD index 92b1bc5df56..e722a88a9a3 100644 --- a/README.MD +++ b/README.MD @@ -71,4 +71,30 @@ https://docusaurus.io/zh-CN/docs/markdown-features/code-blocks - 【使用案例】 - 【支持我们】 - 【来杯咖啡】 - - 【加入我们】 \ No newline at end of file + - 【加入我们】 + + +```bash +# 多语言文档路径 +https://docusaurus.io/docs/i18n/introduction#translation-files-location +https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#i18n + +mkdir -p i18n/en/docusaurus-plugin-content-docs/current +cp -r docs/** i18n/en/docusaurus-plugin-content-docs/current + +mkdir -p i18n/en/docusaurus-plugin-content-docs-quick/current +cp -r quick/** i18n/en/docusaurus-plugin-content-docs-quick/current + + +npm run start -- --locale en + +``` + + + + + + + + + diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 71244b2ef62..86d0bbb625c 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1,4 +1,4 @@ -const LATEST_VERSION_LABEL = 'Latest'; +const LATEST_VERSION_LABEL = '2.8.0-beta'; import type * as Preset from '@docusaurus/preset-classic'; import type { Config } from '@docusaurus/types'; @@ -18,11 +18,21 @@ const config: Config = { projectName: 'gf', onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', + // 多语言配置 i18n: { defaultLocale: 'zh-Hans', - locales: ['zh-Hans'], + locales: ['zh-Hans', 'en'], + path: 'i18n', + localeConfigs: { + en: { + label: 'English', + direction: 'ltr', + htmlLang: 'en-US', + calendar: 'gregory', + path: 'en', + }, + }, }, - presets: [ [ 'classic', @@ -203,6 +213,10 @@ const config: Config = { position: 'right', dropdownActiveClassDisabled: true, }, + { + type: 'localeDropdown', + position: 'right', + }, { href: 'https://github.com/gogf/gf/issues', position: 'right', diff --git "a/i18n/en/docusaurus-plugin-content-docs-quick/current/0-\345\277\253\351\200\237\345\274\200\345\247\213/0-\344\270\213\350\275\275\344\270\216\344\275\277\347\224\250.md" "b/i18n/en/docusaurus-plugin-content-docs-quick/current/0-\345\277\253\351\200\237\345\274\200\345\247\213/0-\344\270\213\350\275\275\344\270\216\344\275\277\347\224\250.md" new file mode 100644 index 00000000000..c2229203840 --- /dev/null +++ "b/i18n/en/docusaurus-plugin-content-docs-quick/current/0-\345\277\253\351\200\237\345\274\200\345\247\213/0-\344\270\213\350\275\275\344\270\216\344\275\277\347\224\250.md" @@ -0,0 +1,75 @@ +--- +slug: '/' +title: '下载与使用en' +hide_title: true +sidebar_position: 0 +--- + +大家好,欢迎访问 `GoFrame` 框架的快速开始章节! +由于 `GoFrame` 是一款模块化、低耦合设计的开发框架,包含了常用的基础组件和开发工具,既可以作为完整的业务项目框架使用也可以作为独立的组件库使用。 + +我们本章节从框架的下载安装使用开始,到指导大家完成一个较完善的`Web Server`接口开发。 + + +:::info +如果您还未准备好`Go`语言开发环境,建议您先查阅环境安装文档:[环境安装](/docs/install-go) +了解一些基础的`Go`语言知识再进行下一步。 +::: + +## 限制 + +为保证框架的稳定性和安全性,`GoFrame`框架要求的最低的基础`Go`语言版本通常会比最新的`Go`语言版本低`1~3`个版本。 + +当前最新框架版本要求的最低`Go`语言版本: +```bash +golang版本 >= 1.20 +``` + +## 安装 +您可以通过以下方式安装框架最新版本: +```bash +go get -u -v github.com/gogf/gf/v2 +``` + +通常,在项目的 `go.mod` 中包含并使用 `GoFrame` 的最新版本: + +```bash +require github.com/gogf/gf/v2 latest +``` +:::note +- 如果您使用的是`Goland IDE`,那么在修改`go.mod`后等待片刻,`IDE`将会自动下载更新最新的`GoFrame`版本。 +- 如果您使用的是其他`IDE`,在修改`go.mod`后,你可以在项目目录下执行: + ```bash + go mod tidy + ``` + 下载更新最新的`GoFrame`版本。 + ::: + +## 运行 + +我们尝试运行以下代码: +```go title="main.go" +package main + +import ( + "fmt" + + "github.com/gogf/gf/v2" +) + +func main() { + fmt.Println("Hello GF:", gf.VERSION) +} +``` +这段简单的代码示例是打印当前引入的`GoFrame`框架版本。通过以下命令执行: +```bash +go run main.go +``` +您将会在终端看到: +```bash +Hello GF: v2.7.4 +``` + +恭喜您!这表示您已经成功引用了`GoFrame`到当前项目中。 + +下一步,我们将使用`GoFrame`开发一个简单的`HTTP Server`服务。 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/index.md b/i18n/en/docusaurus-plugin-content-docs/current/index.md new file mode 100644 index 00000000000..a84c4f7fb68 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/index.md @@ -0,0 +1,4 @@ +--- +title: '开发手册en' +sidebar_position: 0 +--- \ No newline at end of file