Skip to content

Commit dd654af

Browse files
author
cg33
committed
update to gitbook
1 parent e277f15 commit dd654af

File tree

198 files changed

+3909
-3448
lines changed

Some content is hidden

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

198 files changed

+3909
-3448
lines changed

README.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
# Introduction
1+
# GoAdmin Docs
22

33
GoAdmin Documentation
44

55
{% page-ref page="en/" %}
66

7-
{% page-ref page="zh/" %}
8-
9-
10-
7+
{% page-ref page="zh/" %}

SUMMARY.md

+72-76
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,73 @@
1-
# Table of contents
2-
3-
* [Introduction](README.md)
41
* [English](en/README.md)
5-
* [Get Ready](en/install.md)
6-
* [Quick Start](en/quick_start.md)
7-
* [Plugins](en/plugins/README.md)
8-
* [How To Use Plugins](en/plugins/plugins.md)
9-
* [How To Use Admin Plugin](en/plugins/admin.md)
10-
* [Admin Plugins](en/admin-plugins/README.md)
11-
* [Data Table](en/admin-plugins/data-table/README.md)
12-
* [Basic Usage](en/admin-plugins/data-table/basic-usage.md)
13-
* [Column Usage](en/admin-plugins/data-table/column-usage.md)
14-
* [Data Form](en/admin-plugins/data-form/README.md)
15-
* [Basic Usage](en/admin-plugins/data-form/basic-usage.md)
16-
* [Form Components](en/admin-plugins/data-form/form-components.md)
17-
* [Menus](en/admin-plugins/menus.md)
18-
* [Permissions](en/admin-plugins/permissions.md)
19-
* [New Theme](en/admin-plugins/new-theme.md)
20-
* [File Upload](en/admin-plugins/file-upload.md)
21-
* [Cli](en/admin-plugins/cli.md)
22-
* [Pages](en/pages/README.md)
23-
* [Page Modules](en/pages/modules.md)
24-
* [Customize Your Page](en/pages/pages.md)
25-
* [Customize Login Page](en/pages/login.md)
26-
* [Architecture](en/architecture/README.md)
27-
* [Introduction](en/architecture/introduction.md)
28-
* [Development](en/development/README.md)
29-
* [Code Style](en/development/code_style.md)
30-
* [Adapter Development](en/development/adapter.md)
31-
* [Plugins Development](en/development/plugins.md)
32-
* [Template Development](en/template-development/README.md)
33-
* [Template Introducation](en/template-development/template-introducation.md)
34-
* [Form Development](en/template-development/form-development.md)
35-
* [Components](en/template-development/components.md)
36-
* [Plan](en/plan.md)
37-
* [中文](zh/README.md)
38-
* [准备工作](zh/install.md)
39-
* [快速开始](zh/quick_start.md)
40-
* [插件](zh/cha-jian.md)
41-
* [插件的使用](zh/cha-jian-de-shi-yong.md)
42-
* [Admin插件使用](zh/admin-cha-jian-shi-yong.md)
43-
* [Admin插件](zh/admin-cha-jian/README.md)
44-
* [数据表格](zh/admin-cha-jian/shu-ju-biao-ge/README.md)
45-
* [基本使用](zh/admin-cha-jian/shu-ju-biao-ge/ji-ben-shi-yong.md)
46-
* [列的使用](zh/admin-cha-jian/shu-ju-biao-ge/lie-de-shi-yong.md)
47-
* [数据表单](zh/admin-cha-jian/shu-ju-biao-dan/README.md)
48-
* [基本使用](zh/admin-cha-jian/shu-ju-biao-dan/ji-ben-shi-yong.md)
49-
* [表单组件](zh/admin-cha-jian/shu-ju-biao-dan/biao-dan-zu-jian.md)
50-
* [设置菜单](zh/admin-cha-jian/she-zhi-cai-dan.md)
51-
* [权限管理](zh/admin-cha-jian/quan-xian-guan-li.md)
52-
* [模块](zh/admin-cha-jian/mo-kuai.md)
53-
* [使用新主题](zh/admin-cha-jian/shi-yong-xin-zhu-ti.md)
54-
* [文件上传](zh/admin-cha-jian/wen-jian-shang-chuan.md)
55-
* [命令行工具](zh/admin-cha-jian/ming-ling-hang-gong-ju.md)
56-
* [Monitor插件](zh/monitor-cha-jian.md)
57-
* [ui组件介绍](zh/ui-zu-jian-jie-shao/README.md)
58-
* [目录](zh/ui-zu-jian-jie-shao/mu-lu.md)
59-
* [infobox](zh/ui-zu-jian-jie-shao/infobox.md)
60-
* [chartjs](zh/ui-zu-jian-jie-shao/chartjs.md)
61-
* [progress-group](zh/ui-zu-jian-jie-shao/progress-group.md)
62-
* [页面介绍](zh/ye-mian-jie-shao/README.md)
63-
* [页面模块化](zh/ye-mian-jie-shao/ye-mian-mo-kuai-hua.md)
64-
* [自定义页面](zh/ye-mian-jie-shao/zi-ding-yi-ye-mian.md)
65-
* [修改登录界面](zh/ye-mian-jie-shao/xiu-gai-deng-lu-jie-mian.md)
66-
* [项目架构](zh/xiang-mu-jia-gou/README.md)
67-
* [架构介绍](zh/xiang-mu-jia-gou/jia-gou-jie-shao.md)
68-
* [项目开发](zh/xiang-mu-kai-fa/README.md)
69-
* [代码规范](zh/xiang-mu-kai-fa/dai-ma-gui-fan.md)
70-
* [适配器](zh/xiang-mu-kai-fa/shi-pei-qi.md)
71-
* [插件](zh/xiang-mu-kai-fa/cha-jian.md)
72-
* [模板开发](zh/mo-ban-kai-fa/README.md)
73-
* [模板介绍](zh/mo-ban-kai-fa/mo-ban-jie-shao.md)
74-
* [表单组件开发](zh/mo-ban-kai-fa/biao-dan-zu-jian-kai-fa.md)
75-
* [组件开发](zh/mo-ban-kai-fa/zu-jian-kai-fa.md)
76-
* [发展规划](zh/plan.md)
77-
2+
* [Get Ready](en/install.md)
3+
* [Quick Start](en/quick_start.md)
4+
* [Plugins]()
5+
* [How To Use Plugins](en/plugins/plugins.md)
6+
* [How To Use Admin Plugin](en/plugins/admin.md)
7+
* [Admin Plugins]()
8+
* [Data Table]()
9+
* [Basic Usage](en/admin/table/basic.md)
10+
* [Column Usage](en/admin/table/column_usage.md)
11+
* [Data Form]()
12+
* [Basic Usage](en/admin/form/basic.md)
13+
* [Form Components](en/admin/form/components.md)
14+
* [Menus](en/admin/menus.md)
15+
* [Permissions](en/admin/rbac.md)
16+
* [New Theme](en/admin/theme.md)
17+
* [File Upload](en/admin/file.md)
18+
* [Cli](en/admin/cli.md)
19+
* [Pages]()
20+
* [Page Modules](en/pages/modules.md)
21+
* [Customize Your Page](en/pages/pages.md)
22+
* [Customize Login Page](en/pages/login.md)
23+
* [Architecture]()
24+
* [Introduction](en/architecture/introduction.md)
25+
* [Development]()
26+
* [Code Style](en/development/code_style.md)
27+
* [Adapter Development](en/development/adapter.md)
28+
* [Plugins Development](en/development/plugins.md)
29+
* [Template Development]()
30+
* [Template Introducation](en/development/template/template.md)
31+
* [Form Development](en/development/template/form.md)
32+
* [Components](en/development/template/components.md)
33+
* [Plan](en/plan.md)
34+
* [简体中文](zh/README.md)
35+
- [准备工作](zh/install.md)
36+
- [快速开始](zh/quick_start.md)
37+
- [插件]()
38+
- [插件的使用](zh/plugins/plugins.md)
39+
- [Admin插件使用](zh/plugins/admin.md)
40+
- [Admin插件]()
41+
- [数据表格]()
42+
- [基本使用](zh/admin/table/basic.md)
43+
- [列的使用](zh/admin/table/column_usage.md)
44+
- [数据表单]()
45+
- [基本使用](zh/admin/form/basic.md)
46+
- [表单组件](zh/admin/form/components.md)
47+
- [设置菜单](zh/admin/menus.md)
48+
- [权限管理](zh/admin/rbac.md)
49+
- [模块](zh/admin/module.md)
50+
- [使用新主题](zh/admin/theme.md)
51+
- [文件上传](zh/admin/file.md)
52+
- [命令行工具](zh/admin/cli.md)
53+
- [Monitor插件](zh/monitor/monitor.md)
54+
- [ui组件介绍]()
55+
- [目录](zh/components/components.md)
56+
- [infobox](zh/components/infobox.md)
57+
- [chartjs](zh/components/chartjs.md)
58+
- [progress-group](zh/components/progressbar.md)
59+
- [页面介绍]()
60+
- [页面模块化](zh/pages/modules.md)
61+
- [自定义页面](zh/pages/pages.md)
62+
- [修改登录界面](zh/pages/login.md)
63+
- [项目架构]()
64+
- [架构介绍](zh/architecture/introduction.md)
65+
- [项目开发]()
66+
- [代码规范](zh/development/code_style.md)
67+
- [适配器](zh/development/adapter.md)
68+
- [插件](zh/development/plugins.md)
69+
- [模板开发](zh/development/template/template.md)
70+
- [模板介绍](zh/development/template/template.md)
71+
- [表单组件开发](zh/development/template/form.md)
72+
- [组件开发](zh/development/template/components.md)
73+
- [发展规划](zh/plan.md)

en/README.md

+23-17
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,44 @@
1-
# English
1+
# Introduction
2+
------
23

3-
GoAdmin is a data visualization management platform, providing a complete set of visual ui calls to golang programs, and a built-in sql relational database management backend plugin.
4-
5-
Before we build a management backend, we needed at least one back office engineer, a front-end engineer, to take at least a week. Now with GoAdmin, we don't need front-end engineers. Our back-end engineers don't even need to know the front-end knowledge. We can build a complete back-end management system in half an hour. If your requirements are not complicated, just simple crud, then all you need are serveral golang files, and all files can be packaged into a single binary file, which is very convenient for distribution and deployment.
4+
GoAdmin is a data visualization management platform, providing a complete set of visual ui calls to golang programs, and a built-in sql relational database management backend plugin.
5+
<br>
6+
<br>
7+
Before we build a management backend, we needed at least one back office engineer, a front-end engineer, to take at least a week.
8+
Now with GoAdmin, we don't need front-end engineers. Our back-end engineers don't even need to know the front-end knowledge. We can build a complete back-end management system in half an hour.
9+
If your requirements are not complicated, just simple crud, then all you need are serveral golang files, and all files can be packaged into a single binary file, which is very convenient for distribution and deployment.
610

711
here is very simple example which show you how it work: [https://github.com/GoAdminGroup/example](https://github.com/GoAdminGroup/example)
812

13+
914
## Features
1015

11-
* Build-in RBAC Access Authentication System
12-
* Support most web framework
13-
* Support plug-ins\(working on it\)
14-
* Provided different ui theme\(only Adminlte now, others are coming soon.\)
16+
- Build-in RBAC Access Authentication System
17+
- Support most web framework
18+
- Support plug-ins(working on it)
19+
- Provided different ui theme(only Adminlte now, others are coming soon.)
1520

1621
## Demo
1722

1823
[https://demo.go-admin.cn/admin](https://demo.go-admin.cn/admin)
1924

2025
## Dependencies
2126

22-
* [Datetimepicker](http://eonasdan.github.io/bootstrap-datetimepicker/)
23-
* [font-awesome](http://fontawesome.io/)
24-
* [bootstrap-fileinput](https://github.com/kartik-v/bootstrap-fileinput)
25-
* [jquery-pjax](https://github.com/defunkt/jquery-pjax)
26-
* [Nestable](http://dbushell.github.io/Nestable/)
27-
* [toastr](http://codeseven.github.io/toastr/)
28-
* [bootstrap-number-input](https://github.com/wpic/bootstrap-number-input)
29-
* [fontawesome-iconpicker](https://github.com/itsjavi/fontawesome-iconpicker)
27+
- [Datetimepicker](http://eonasdan.github.io/bootstrap-datetimepicker/)
28+
- [font-awesome](http://fontawesome.io/)
29+
- [bootstrap-fileinput](https://github.com/kartik-v/bootstrap-fileinput)
30+
- [jquery-pjax](https://github.com/defunkt/jquery-pjax)
31+
- [Nestable](http://dbushell.github.io/Nestable/)
32+
- [toastr](http://codeseven.github.io/toastr/)
33+
- [bootstrap-number-input](https://github.com/wpic/bootstrap-number-input)
34+
- [fontawesome-iconpicker](https://github.com/itsjavi/fontawesome-iconpicker)
3035

3136
## Community
3237

3338
[Community](http://forum.go-admin.cn)
3439

3540
## Backers
3641

37-
Your support will help me do better!
42+
Your support will help me do better!
3843

44+
<a href="https://opencollective.com/go-admin#backers" target="_blank"><img src="https://opencollective.com/go-admin/backers.svg?width=890"></a>

en/SUMMARY.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
* [Introducation]()
2+
* [Get Ready](install)
3+
* [Quick Start](quick_start)
4+
* [Plugins]()
5+
* [How To Use Plugins](plugins/plugins)
6+
* [How To Use Admin Plugin](plugins/admin)
7+
* [Admin Plugins]()
8+
* [Data Table]()
9+
* [Basic Usage](admin/table/basic)
10+
* [Column Usage](admin/table/column_usage)
11+
* [Data Form]()
12+
* [Basic Usage](admin/form/basic)
13+
* [Form Components](admin/form/components)
14+
* [Menus](admin/menus)
15+
* [Permissions](admin/rbac)
16+
* [New Theme](admin/theme)
17+
* [File Upload](admin/file)
18+
* [Cli](admin/cli)
19+
* [Pages]()
20+
* [Page Modules](pages/modules)
21+
* [Customize Your Page](pages/pages)
22+
* [Customize Login Page](pages/login)
23+
* [Architecture]()
24+
* [Introduction](architecture/introduction)
25+
* [Development]()
26+
* [Code Style](development/code_style)
27+
* [Adapter Development](development/adapter)
28+
* [Plugins Development](development/plugins)
29+
* [Template Development]()
30+
* [Template Introducation](development/template/template)
31+
* [Form Development](development/template/form)
32+
* [Components](development/template/components)
33+
* [Plan](plan)
34+
- **Links**
35+
- [![Code](https://icongr.am/feather/code.svg?size=16&color=808080)Demo](https://demo.go-admin.com/admin)
36+
- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/GoAdminGroup/go-admin)

en/admin-plugins/README.md

-2
This file was deleted.

en/admin-plugins/cli.md

-2
This file was deleted.

en/admin-plugins/data-form/README.md

-2
This file was deleted.

en/admin-plugins/data-form/basic-usage.md

-2
This file was deleted.

en/admin-plugins/data-form/form-components.md

-2
This file was deleted.

en/admin-plugins/data-table/README.md

-2
This file was deleted.

en/admin-plugins/data-table/basic-usage.md

-2
This file was deleted.

en/admin-plugins/data-table/column-usage.md

-2
This file was deleted.

en/admin-plugins/file-upload.md

-2
This file was deleted.

en/admin-plugins/menus.md

-2
This file was deleted.

en/admin-plugins/new-theme.md

-2
This file was deleted.

en/admin-plugins/permissions.md

-2
This file was deleted.

en/admin/cli.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Cli Introduction
2+
---
3+
4+
GoAdmin provides a command line tool to increase development efficiency and streamline the development process.
5+
6+
## Install
7+
8+
9+
Download the binary of the corresponding system:
10+
11+
| File name | OS | Arch | Size |
12+
| ---- | ---- | ---- |---- |
13+
| [adm_darwin_x86_64_v1.1.3.zip](http://file.go-admin.cn/go_admin/cli/v1_1_3/adm_darwin_x86_64_v1.1.3.zip) | macOs | x86-64 | 4.77 MB
14+
| [adm_linux_x86_64_v1.1.3.zip](http://file.go-admin.cn/go_admin/cli/v1_1_3/adm_linux_x86_64_v1.1.3.zip) | Linux | x86-64 | 6.52 MB
15+
| [adm_linux_armel_v1.1.3.zip](http://file.go-admin.cn/go_admin/cli/v1_1_3/adm_linux_armel_v1.1.3.zip) | Linux | x86 | 6.06 MB
16+
| [adm_windows_i386_v1.1.3.zip](http://file.go-admin.cn/go_admin/cli/v1_1_3/adm_windows_i386_v1.1.3.zip) | Windows | x86 |6.16 MB
17+
| [adm_windows_x86_64_v1.1.3.zip](http://file.go-admin.cn/go_admin/cli/v1_1_3/adm_windows_x86_64_v1.1.3.zip) | Windows | x86-64 |6.38 MB
18+
19+
20+
Or use the command to install:
21+
22+
```
23+
go install github.com/GoAdminGroup/go-admin/adm
24+
```
25+
26+
## Usage
27+
28+
Use
29+
30+
```
31+
adm --help
32+
```
33+
34+
Will list help information.
35+
36+
| Command | Subcommand | Options | Function |
37+
| ---- | ---- | ---- | ---- |
38+
| generate | - | - | generate a data model file.
39+
| compile | asset| **-s, --src** front-end resource folder path<br>**-d, --dist** output go file path | compile all resource files into one single go file.
40+
| compile | tpl | **-s, --src** the input golang tmpl template folder path<br>**-d, --dist** output go file path<br>**p, --package** output go file package name | compile all template files into one single go file.
41+
| combine | css| **-s, --src** the input css folder path<br>**-d, --dist** the output css file path<br>**p, --package** output go file package name | combine the css files into one single css file.
42+
| combine | js | **-s, --src** the input js folder path<br>**-d, --dist** the output js file path | combine the js files into one single js file.
43+
| develop | tpl | **-m, --module** golang module name or path under $GOPATH<br>**-n, --name** theme name | fetch remotely theme development templates to local.

0 commit comments

Comments
 (0)