Skip to content

Commit f91534f

Browse files
committed
foc: use docusaurus to init doc
1 parent 881516e commit f91534f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+14100
-0
lines changed

docs/.eslintrc.js

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
module.exports = {
2+
"env": {
3+
"browser": true,
4+
"es2021": true
5+
},
6+
"extends": "plugin:react/recommended",
7+
"overrides": [
8+
{
9+
"env": {
10+
"node": true
11+
},
12+
"files": [
13+
".eslintrc.{js,cjs}"
14+
],
15+
"parserOptions": {
16+
"sourceType": "script"
17+
}
18+
}
19+
],
20+
"parserOptions": {
21+
"ecmaVersion": "latest",
22+
"sourceType": "module"
23+
},
24+
"plugins": [
25+
"react"
26+
],
27+
"rules": {
28+
}
29+
}

docs/.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Dependencies
2+
/docusaurus/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*
21+
22+
# IDE
23+
.idea
24+
.idea/*

docs/README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# ODPS SDK 文档目录 README
2+
3+
## 简介
4+
5+
此目录用于维护和构建 ODPS SDK 的官方文档,采用 Docusaurus 进行文档的编写与管理,并利用 GitHub Pages 功能将其托管于 [https://aliyun.github.io/aliyun-odps-java-sdk/](https://aliyun.github.io/aliyun-odps-java-sdk/) 。当前文档正处于积极开发阶段,并且仅提供中文版本。
6+
7+
## 文档构建工具 - Docusaurus
8+
9+
Docusaurus 是一个强大的静态站点生成器,特别适合构建和维护开源项目的文档网站。它的中文文档可以在 [Docusaurus 中文官网](https://docusaurus.io/zh-CN/docs) 找到,这里详细介绍了如何开始、配置以及进阶使用 Docusaurus。
10+
11+
## 文档目录结构
12+
13+
文档源文件位于 `docs/docs` 目录下。请在此目录中添加、修改或删除文档内容。
14+
15+
## 开发环境搭建与本地调试
16+
17+
### 初始化项目
18+
19+
在 docs 目录下,请确保运行以下命令以安装所有依赖:
20+
21+
```bash
22+
yarn install
23+
```
24+
25+
### 本地运行与预览
26+
27+
安装完依赖后,你可以通过以下命令启动本地开发服务器,进行实时预览和调试:
28+
29+
```bash
30+
yarn start
31+
```
32+
33+
这将自动打开浏览器并显示文档的本地预览版。
34+
35+
## 部署文档
36+
37+
### 当前部署流程
38+
39+
目前文档部署为手动过程,但考虑未来可能采用 GitHub Actions 自动化部署。
40+
41+
#### 手动部署步骤
42+
43+
1. 确保你的文档是最新的,并且你已经测试过。
44+
2. 在项目根目录下的 `docs` 目录中执行以下命令:
45+
46+
```bash
47+
USE_SSH=true yarn deploy
48+
```
49+
50+
该命令会使用 SSH 方式(如果配置了)将编译好的网站发布到 `gh-pages` 分支。此过程包括创建一个临时目录,复制编译后的文件至该目录,然后推送至 GitHub。
51+
52+
#### 注意事项
53+
54+
- 如果因 Git Hooks 或其他原因导致自动推送失败,你可以手动进入该临时目录,并执行 `git push` 来完成部署。
55+
- 确保你有正确的权限推送至 `gh-pages` 分支。
56+
57+
---
58+
59+
文档持续更新中,对于任何问题、建议或想要贡献的意愿,请随时开启 Issue 或发起 Pull Request。让我们共同完善 ODPS SDK 的文档资源!

docs/babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

docs/docs/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "java",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "doc of odps java sdk"
7+
}
8+
}

docs/docs/api-reference/Account.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Account
3+
sidebar_position: 3
4+
---

docs/docs/api-reference/CompressOption.md

Whitespace-only changes.

0 commit comments

Comments
 (0)