Skip to content

Commit

Permalink
Documents -> Documentation in md
Browse files Browse the repository at this point in the history
  • Loading branch information
gqcn committed Nov 27, 2024
1 parent 9e5a60a commit 0928150
Show file tree
Hide file tree
Showing 46 changed files with 46 additions and 46 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ It should be noted that `Response` requires a manual call to the `Close` method
1. The `ghttp` client defaults to disabling the `KeepAlive` feature and the verification function for the server's `TLS` certificate. If you need to enable it, you can customize the client's `Transport` attribute.
2. These advanced functions such as **Connection Pool Parameter Setting** and **Connection Proxy Settings** can also be achieved by customizing the client's `Transport` attribute. This data inherits from the standard library's `http.Transport` object.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Taking a common HTTP request as an example, the `Session` object in `ghttp.Reque

When a user's `Session` is no longer needed, for instance, when a user logs out, the session needs to be hard-deleted from storage. This can be done by calling the `RemoveAll` method.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ function DoAjax(url) {

Please refer to subsequent chapters for specific usage examples.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `GoFrame` framework supports fully automated API documentation generation, e

![](/markdown/487a4457a16a6cf2c86a7d706ce0d9cd.png)

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Additionally, it is worth mentioning that `Header` operations can be implemented
Response.Header().Set("Content-Type", "text/plain; charset=utf-8")
```

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ Running the client repeatedly, the output results are all:

This means the parameters are all values submitted in `Body`, not the values from the route parameters. In fact, **due to the case-sensitive nature of parameters**, the server received two parameters at this time, one is the route parameter `path`, the other is the `Path` submitted in `Body JSON`. When converting to an `API` parameter object, the server uses the value from `Body JSON` since the attribute `Path` matches the `Path` in `Body JSON` more closely.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Starting from version `v2.0`, the `Server` component of the framework provides a
Please note that **specified router** along with the original **function, object, group** routing methods are all registration methods supported by the framework's `HTTP Server` component. They are designed to solve scenarios of standardized and automated API management and are more suitable for multi-person team collaboration. Other routing methods, especially the function and object registration methods of the framework's `v1` version, are also supported in the new version! Choose reasonably based on personal usage habits.
:::

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ API documentation: [https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp](https://

Starting from version `v2` of the framework, the feature of **standardized routing** has been added, making it more suitable for engineering scenarios in business projects. It is recommended to use standardized routing in complex business projects: [Standard Router](路由注册-规范路由/路由注册-规范路由.md)

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ DESCRIPTION
Please use "gf gen dao -h" for specified type help.
```

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ ADDITIONAL
Use "gf COMMAND -h" for details about a command.
```

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ $ go run client.go
2023-03-14 20:52:37.060 [DEBU] {9898c809364a4c17da79e47f3e6c3b8f} Response: Hello World
```

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import "github.com/gogf/gf/v2/i18n/gi18n"
[https://pkg.go.dev/github.com/gogf/gf/v2/i18n/gi18n](https://pkg.go.dev/github.com/gogf/gf/v2/i18n/gi18n)


## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ When compared to `Cobra`, the `gcmd` command line component of the `GoFrame` fra
- The `gcmd` component allows reading parameters via configuration components when there are no terminal arguments.
- The `gcmd` component supports tracing to facilitate the transfer of trace information between parent and child processes.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ type Driver interface {

The `New` method is used to create a database operation object corresponding to the driver based on the `Core` database base object and the `ConfigNode` configuration object. It should be noted that the returned database object needs to implement the `DB` interface. The database base object `Core` has already implemented the `DB` interface, so developers only need to "inherit" the `Core` object and then override the corresponding interface implementation methods as needed.

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ For a complete database configuration, please refer to the [ORM - Configuration]
When a data table contains any or multiple fields such as `created_at`, `updated_at`, `deleted_at`, or contains corresponding configuration fields in the configuration file, this feature is automatically enabled.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Below is the support status of the latest version
| `dm` | Unsupported | Supported | Supported | Supported | Supported | Supported | Supported |
| `clickhouse` | Unsupported | Unsupported | Unsupported | Unsupported | Supported | Unsupported | Unsupported |

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ db, err := gdb.Instance()
db, err := gdb.Instance("user")
```

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The `gvalid` component has the following notable features:
- Supports custom validation rules
- Supports internationalization feature `I18n`

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The log component supports the singleton pattern, using `g.Log(singleton name)`
Since each component of the framework is **decoupled**, the framework **can be used as an independent tool library**. For example, if the project only needs to use the log component, you can directly use the methods of the `glog` package, without introducing other components. However, in project engineering use, the use of the tool library may be more cumbersome, often involving configuration and component initialization (in most cases, this will lead to secondary encapsulation). Therefore, the framework also provides a **coupled package** called the `g` package. This package loads some commonly used components by default. `g.Log()` is one of the log components, which will automatically read and initialize the configuration object according to engineering specifications, quickly initialize the log object and achieve singleton management, greatly simplifying the use of logs under engineering. For more introductions, please refer to: [Objects](../对象管理.md)
:::

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ g.View().SetPath("/opt/template")

The template engine uses a carefully designed **cache mechanism**. When a template file is first read, it is cached in memory, and future reads will directly access the cache to improve execution efficiency. Additionally, the template engine provides an **automatic update detection mechanism** for template files. When a template file is modified externally, the template engine can promptly detect it and refresh the cache content of the template file.

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import "github.com/gogf/gf/v2/util/gconv"

The method list may lag behind the code, please refer to the API documentation for details.

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ After execution, the console outputs:
&main.User{Id:1, Name:"GoFrame", Site:"https://goframe.org"}
```

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Starting from `Golang v1.16`, the official release provides a static file embedd

In the future, the GoFrame base framework will not consider built-in support for the `embed.FS` component. `embed.FS` and the `gres` component can be independently used without affecting each other.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The configuration object can retrieve the currently used interface implementatio
func (c *Config) GetAdapter() Adapter
```

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The `gcfg` component has the following notable features:

The framework's configuration component supports a variety of common data formats, but the subsequent example code will be demonstrated using the `yaml` data format. In use, feel free to use the data format of your choice **without being restricted to the `yaml` data format used in the official examples**. For example, if the business project template provides a `config.yaml` configuration file template (because the default template can only provide one), you can also directly modify it to `config.toml` or `config.ini` and other supported data formats, **the configuration component can also automatically recognize and read based on the file name suffix**.

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import "github.com/gogf/gf/v2/errors/gerror"

[https://pkg.go.dev/github.com/gogf/gf/v2/errors/gerror](https://pkg.go.dev/github.com/gogf/gf/v2/errors/gerror)

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The engineering development design provided on the framework's official website

Reviewing all the design sections here and understanding the background and ideas of each piece of design itself is more valuable than directly using framework components and tools.

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The `gredis.Redis` client object provides a `Close` method, which is used to clo
- Supports singleton objects and dynamic object creation
- Interface design with high flexibility and extensibility

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import "github.com/gogf/gf/v2/container/gmap"

[https://pkg.go.dev/github.com/gogf/gf/v2/container/gmap](https://pkg.go.dev/github.com/gogf/gf/v2/container/gmap)

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import "github.com/gogf/gf/v2/container/gtype"

[https://pkg.go.dev/github.com/gogf/gf/v2/container/gtype](https://pkg.go.dev/github.com/gogf/gf/v2/container/gtype)

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Two points to note:

The object lifecycle in `sync.Pool` does not support customizable expiration time because `sync.Pool` is not a `Cache`; the original intention of `sync.Pool` is to alleviate GC `pressure`, and the objects in `sync.Pool` are all cleared before `GC` starts; furthermore, `sync.Pool` does not support object creation and destruction methods.

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Brief Description:
- `SortedArray`, `SortedIntArray`, `SortedStrArray`
- Among them, the sorted array `SortedArray` requires a given sorting comparison method, and many `Comparator*` comparison methods are also defined in the toolkit `gutil`.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func ComparatorUint64(a, b interface{}) int
func ComparatorUint8(a, b interface{}) int
```

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import "github.com/gogf/gf/v2/container/gvar"

[https://pkg.go.dev/github.com/gogf/gf/v2/container/gvar](https://pkg.go.dev/github.com/gogf/gf/v2/container/gvar)

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import "github.com/gogf/gf/v2/container/glist"

[https://pkg.go.dev/github.com/gogf/gf/v2/container/glist](https://pkg.go.dev/github.com/gogf/gf/v2/container/glist)

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import "github.com/gogf/gf/v2/container/gqueue"

[https://pkg.go.dev/github.com/gogf/gf/v2/container/gqueue](https://pkg.go.dev/github.com/gogf/gf/v2/container/gqueue)

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import "github.com/gogf/gf/v2/container/gset"

**Interface Documentation**: [https://pkg.go.dev/github.com/gogf/gf/v2/container/gset](https://pkg.go.dev/github.com/gogf/gf/v2/container/gset)

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import "github.com/gogf/gf/v2/text/gregex"

[https://pkg.go.dev/github.com/gogf/gf/v2/text/gregex](https://pkg.go.dev/github.com/gogf/gf/v2/text/gregex)

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import "github.com/gogf/gf/v2/os/gcron"

- Influence of Global Timezone: Scheduled tasks strictly depend on time calculation, so the global timezone of the process greatly affects scheduled task execution. When adding scheduled tasks, pay attention to the global timezone settings of the current process. If no global timezone is set, the system timezone is used by default. For more information on timezone settings, please refer to: [Time - Time Zone](../时间管理-gtime/时间管理-时区设置.md)

## Documents
## Documentation
import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ It should be noted that the shorter the default detection interval of the timer,

Please refer to the section [Cron Job](../定时任务-gcron/定时任务-gcron与gtimer.md)

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ It is recommended to use the `Add` and `Remove` module methods provided by the `

Additionally, you can also create a watching management object using the `New` method and then perform watching management. When adding watching, you need to provide a callback function that triggers during watching, with the parameter type being a `*gfsnotify.Event` object pointer.

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import "github.com/gogf/gf/v2/os/gtime"

[https://pkg.go.dev/github.com/gogf/gf/v2/os/gtime](https://pkg.go.dev/github.com/gogf/gf/v2/os/gtime)

## Documents
## Documentation

import DocCardList from '@theme/DocCardList';

Expand Down
Loading

0 comments on commit 0928150

Please sign in to comment.