update docs

README.md

@@ -7,10 +7,18 @@
 
 ## Introduction
 
-`fastapi-admin` is a fast admin dashboard based on [FastAPI](https://github.com/tiangolo/fastapi) and [TortoiseORM](https://github.com/tortoise/tortoise-orm/) with [tabler](https://github.com/tabler/tabler) ui, inspired by Django admin.
+`fastapi-admin` is a fast admin dashboard based on [FastAPI](https://github.com/tiangolo/fastapi)
+and [TortoiseORM](https://github.com/tortoise/tortoise-orm/) with [tabler](https://github.com/tabler/tabler) ui,
+inspired by Django admin.
 
 Looking for old version? See branch [v1](https://github.com/fastapi-admin/fastapi-admin/tree/v1).
 
+## Installation
+
+```shell
+> pip install fastapi-admin
+```
+
 ## Online Demo
 
 You can check a online demo [here](https://fastapi-admin.long2ice.cn).

docs/en/docs/getting_started/index.md

@@ -0,0 +1 @@
+../../../../README.md

docs/en/docs/getting_started/installation.md

@@ -0,0 +1,33 @@
+# Installation
+
+## From pypi
+
+You can install from pypi.
+
+```shell
+> pip install fastapi-admin
+```
+
+## From source
+
+Or you can install from source with latest code.
+
+```shell
+> pip install git+https://github.com/fastapi-admin/fastapi-admin.git
+```
+
+### With requirements.txt
+
+Add the following line.
+
+```shell
+-e https://github.com/fastapi-admin/fastapi-admin.git@develop#egg=fastapi-admin
+```
+
+### With poetry
+
+Add the following line in section `[tool.poetry.dependencies]`.
+
+```toml
+fastapi-admin = { git = 'https://github.com/fastapi-admin/fastapi-admin.git', branch = 'develop' }
+```

docs/en/docs/getting_started/quickstart.md

@@ -0,0 +1 @@
+# Quickstart

docs/en/docs/pro/index.md

@@ -0,0 +1,13 @@
+# Content
+
+## Login Captcha and failed IP limitation
+
+## Additional File Upload Providers
+
+## Error pages
+
+## Free consultation
+
+## Others
+
+...

docs/en/docs/pro/installation.md

@@ -0,0 +1 @@
+# Installation

docs/en/docs/pro/sponsor.md

@@ -0,0 +1 @@
+# Sponsor

docs/en/mkdocs.yml

@@ -0,0 +1,63 @@
+site_name: FastAPI Admin
+site_url: https://github.com/fastapi-admin/fastapi-admin
+repo_url: https://github.com/fastapi-admin/fastapi-admin
+site_description: A fast admin dashboard based on FastAPI and TortoiseORM with tabler ui, inspired by Django admin.
+repo_name: fastapi-admin/fastapi-admin
+site_author: long2ice
+theme:
+  logo: https://fastapi.tiangolo.com/img/icon-white.svg
+  favicon: https://fastapi.tiangolo.com/img/favicon.png
+  name: material
+  language: en
+  icon:
+    repo: fontawesome/brands/github
+  palette:
+    - scheme: default
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to default mode
+    - scheme: slate
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/lightbulb
+        name: Switch to dark mode
+  features:
+    - navigation.instant
+    - navigation.tabs
+    - search.suggest
+    - search.highlight
+    - navigation.top
+markdown_extensions:
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.superfences
+nav:
+  - Getting Started:
+      - getting_started/index.md
+      - getting_started/installation.md
+      - getting_started/quickstart.md
+  - Reference:
+      - reference/index.md
+  - Pro Version For Sponsor:
+      - pro/index.md
+      - pro/sponsor.md
+      - pro/installation.md
+extra:
+  alternate:
+    - name: English
+      link: /
+    - name: 简体中文
+      link: /zh/
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/long2ice
+
+copyright: Copyright © 2021 long2ice
+
+plugins:
+  - git-revision-date-localized:
+      type: datetime
+  - markdownextradata

docs/getting_started.md

@@ -1 +0,0 @@
-../README.md

docs/getting_started.zh.md

@@ -1 +0,0 @@
-../README-zh.md

docs/index.md

@@ -1 +0,0 @@
-# Home

docs/zh/mkdocs.yml

@@ -5,35 +5,47 @@ site_description: A fast admin dashboard based on FastAPI and TortoiseORM with t
 repo_name: fastapi-admin/fastapi-admin
 site_author: long2ice
 theme:
+  logo: https://fastapi.tiangolo.com/img/icon-white.svg
+  favicon: https://fastapi.tiangolo.com/img/favicon.png
   name: material
+  language: zh
   icon:
     repo: fontawesome/brands/github
   palette:
-    primary: deep purple
+    - scheme: default
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to default mode
+    - scheme: slate
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/lightbulb
+        name: Switch to dark mode
   features:
     - navigation.instant
     - navigation.tabs
     - search.suggest
     - search.highlight
+    - navigation.top
 markdown_extensions:
   - pymdownx.highlight
   - pymdownx.inlinehilite
   - pymdownx.superfences
 nav:
-  - index.md
-  - Getting Started:
+  - 首页: index.md
+  - 入门指南:
       - getting_started.md
-  - Pro Features:
+  - Pro 特性:
       - pro/sponsor.md
-
 extra:
   alternate:
     - name: English
-      link: /latest/en/
-      lang: en
+      link: /
     - name: 简体中文
-      link: /latest/zh/
-      lang: zh
+      link: /zh/
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/long2ice
@@ -41,12 +53,5 @@ extra:
 copyright: Copyright © 2021 long2ice
 
 plugins:
-  - mike:
-      version_selector: true
-  - i18n:
-      default_language: en
-      languages:
-        en: English
-        zh: 简体中文
   - git-revision-date-localized:
-      type: date
+      type: datetime

examples/routes.py

@@ -12,7 +12,7 @@ async def home(
     resources=Depends(get_resources),
 ):
     return templates.TemplateResponse(
-        "home.html",
+        "main.html",
         context={
             "request": request,
             "resources": resources,

images/icon-white.svg

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   id="svg8"
+   version="1.1"
+   viewBox="0 0 6.3499999 6.3499999"
+   height="6.3499999mm"
+   width="6.3499999mm">
+  <defs
+     id="defs2" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     transform="translate(-87.539286,-84.426191)"
+     id="layer1">
+    <path
+       id="path815"
+       d="m 87.539286,84.426191 h 6.35 v 6.35 h -6.35 z"
+       style="fill:none;stroke-width:0.26458332" />
+    <path
+       style="stroke-width:0.26458332;fill:#ffffff"
+       id="path817"
+       d="m 90.714286,84.960649 c -1.457854,0 -2.640542,1.182688 -2.640542,2.640542 0,1.457854 1.182688,2.640542 2.640542,2.640542 1.457854,0 2.640542,-1.182688 2.640542,-2.640542 0,-1.457854 -1.182688,-2.640542 -2.640542,-2.640542 z m -0.137583,4.757209 v -1.656292 h -0.92075 l 1.322916,-2.577042 v 1.656292 h 0.886354 z" />
+  </g>
+</svg>

poetry.lock

@@ -370,24 +370,6 @@ category = "dev"
 optional = false
 python-versions = "*"
 
-[[package]]
-name = "mike"
-version = "1.0.0"
-description = "Manage multiple versions of your MkDocs-powered documentation"
-category = "dev"
-optional = false
-python-versions = "*"
-
-[package.dependencies]
-jinja2 = "*"
-mkdocs = ">=1.0"
-pyyaml = "*"
-verspec = "*"
-
-[package.extras]
-dev = ["coverage", "flake8 (>=3.0)"]
-test = ["coverage", "flake8 (>=3.0)"]
-
 [[package]]
 name = "mkdocs"
 version = "1.1.2"
@@ -418,6 +400,18 @@ babel = ">=2.7.0"
 GitPython = "*"
 mkdocs = ">=1.0"
 
+[[package]]
+name = "mkdocs-markdownextradata-plugin"
+version = "0.2.4"
+description = "A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template"
+category = "dev"
+optional = false
+python-versions = ">=2.7.9,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*"
+
+[package.dependencies]
+mkdocs = "*"
+pyyaml = "*"
+
 [[package]]
 name = "mkdocs-material"
 version = "7.1.3"
@@ -444,17 +438,6 @@ python-versions = ">=3.5"
 [package.dependencies]
 mkdocs-material = ">=5.0.0"
 
-[[package]]
-name = "mkdocs-static-i18n"
-version = "0.12"
-description = "MkDocs i18n plugin using static translation markdown files"
-category = "dev"
-optional = false
-python-versions = ">=3.6"
-
-[package.dependencies]
-mkdocs = ">=1.1.2"
-
 [[package]]
 name = "mypy"
 version = "0.812"
@@ -591,7 +574,7 @@ python-versions = ">=3.5"
 
 [[package]]
 name = "pylint"
-version = "2.8.1"
+version = "2.8.2"
 description = "python code static checker"
 category = "dev"
 optional = false
@@ -865,17 +848,6 @@ typing-extensions = {version = "*", markers = "python_version < \"3.8\""}
 [package.extras]
 standard = ["websockets (>=8.0.0,<9.0.0)", "watchgod (>=0.6)", "python-dotenv (>=0.13)", "PyYAML (>=5.1)", "httptools (>=0.1.0,<0.2.0)", "uvloop (>=0.14.0,!=0.15.0,!=0.15.1)", "colorama (>=0.4)"]
 
-[[package]]
-name = "verspec"
-version = "0.1.0"
-description = "Flexible version handling"
-category = "dev"
-optional = false
-python-versions = "*"
-
-[package.extras]
-test = ["coverage", "flake8 (>=3.7)", "mypy", "pretend", "pytest"]
-
 [[package]]
 name = "wrapt"
 version = "1.12.1"
@@ -902,7 +874,7 @@ accel = []
 [metadata]
 lock-version = "1.1"
 python-versions = "^3.7"
-content-hash = "458e97edbef2b5a0975030a812aa90f5b4f29a1b221e2cc146e305b1e14aeb48"
+content-hash = "1e6c6d920b7f669cf7fa1b92f2428e44d3148bbe29dc2b4d2aa1bdbcea571ce3"
 
 [metadata.files]
 aiofiles = [
@@ -1144,10 +1116,6 @@ mccabe = [
     {file = "mccabe-0.6.1-py2.py3-none-any.whl", hash = "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42"},
     {file = "mccabe-0.6.1.tar.gz", hash = "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"},
 ]
-mike = [
-    {file = "mike-1.0.0-py3-none-any.whl", hash = "sha256:521261cc1d72c07b995c0b80e0031c971d8839c9720c1a884203d9e4bdc6a47b"},
-    {file = "mike-1.0.0.tar.gz", hash = "sha256:15819cef713366e58c85202a622871a0b62c85f227bc47e8525e17c7ad8198c6"},
-]
 mkdocs = [
     {file = "mkdocs-1.1.2-py3-none-any.whl", hash = "sha256:096f52ff52c02c7e90332d2e53da862fde5c062086e1b5356a6e392d5d60f5e9"},
     {file = "mkdocs-1.1.2.tar.gz", hash = "sha256:f0b61e5402b99d7789efa032c7a74c90a20220a9c81749da06dbfbcbd52ffb39"},
@@ -1156,6 +1124,9 @@ mkdocs-git-revision-date-localized-plugin = [
     {file = "mkdocs-git-revision-date-localized-plugin-0.9.tar.gz", hash = "sha256:49e59396f1e83264b8f54fcb339a9137925a1af19e639f03dc59dae7f22e914f"},
     {file = "mkdocs_git_revision_date_localized_plugin-0.9-py3-none-any.whl", hash = "sha256:5d319398e9ce325d02df1cba232a92b215f8d0c0ffd3810b6a61d6c5eb6306e6"},
 ]
+mkdocs-markdownextradata-plugin = [
+    {file = "mkdocs_markdownextradata_plugin-0.2.4-py3-none-any.whl", hash = "sha256:9acf1860488e8e990c77de2af2e575b36dfc2a24c46ac63789315f78d2a3b709"},
+]
 mkdocs-material = [
     {file = "mkdocs-material-7.1.3.tar.gz", hash = "sha256:e34bba93ad1a0e6f9afc371f4ef55bedabbf13b9a786b013b0ce26ac55ec2932"},
     {file = "mkdocs_material-7.1.3-py2.py3-none-any.whl", hash = "sha256:437638b0de7a9113d7f1c9ddc93c0a29a3b808c71c3606713d8c1fa437697a3e"},
@@ -1164,9 +1135,6 @@ mkdocs-material-extensions = [
     {file = "mkdocs-material-extensions-1.0.1.tar.gz", hash = "sha256:6947fb7f5e4291e3c61405bad3539d81e0b3cd62ae0d66ced018128af509c68f"},
     {file = "mkdocs_material_extensions-1.0.1-py3-none-any.whl", hash = "sha256:d90c807a88348aa6d1805657ec5c0b2d8d609c110e62b9dce4daf7fa981fa338"},
 ]
-mkdocs-static-i18n = [
-    {file = "mkdocs-static-i18n-0.12.tar.gz", hash = "sha256:23dae2acfb5624dd33443e64fbf876e6bc0ce9255f766da56532d34b50082668"},
-]
 mypy = [
     {file = "mypy-0.812-cp35-cp35m-macosx_10_9_x86_64.whl", hash = "sha256:a26f8ec704e5a7423c8824d425086705e381b4f1dfdef6e3a1edab7ba174ec49"},
     {file = "mypy-0.812-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:28fb5479c494b1bab244620685e2eb3c3f988d71fd5d64cc753195e8ed53df7c"},
@@ -1256,8 +1224,8 @@ pygments = [
     {file = "Pygments-2.8.1.tar.gz", hash = "sha256:2656e1a6edcdabf4275f9a3640db59fd5de107d88e8663c5d4e9a0fa62f77f94"},
 ]
 pylint = [
-    {file = "pylint-2.8.1-py3-none-any.whl", hash = "sha256:4236b7284853b779a8add49aca287a5899245894995c5591d2b5839a32482330"},
-    {file = "pylint-2.8.1.tar.gz", hash = "sha256:ad1bff19c46bfc6d2aeba4de5f76570d253df4915d2043ba61dc6a96233c4bd6"},
+    {file = "pylint-2.8.2-py3-none-any.whl", hash = "sha256:f7e2072654a6b6afdf5e2fb38147d3e2d2d43c89f648637baab63e026481279b"},
+    {file = "pylint-2.8.2.tar.gz", hash = "sha256:586d8fa9b1891f4b725f587ef267abe2a1bad89d6b184520c7f07a253dd6e217"},
 ]
 pymdown-extensions = [
     {file = "pymdown-extensions-8.1.1.tar.gz", hash = "sha256:632371fa3bf1b21a0e3f4063010da59b41db049f261f4c0b0872069a9b6d1735"},
@@ -1309,26 +1277,18 @@ pyyaml = [
     {file = "PyYAML-5.4.1-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:bb4191dfc9306777bc594117aee052446b3fa88737cd13b7188d0e7aa8162185"},
     {file = "PyYAML-5.4.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:6c78645d400265a062508ae399b60b8c167bf003db364ecb26dcab2bda048253"},
     {file = "PyYAML-5.4.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:4e0583d24c881e14342eaf4ec5fbc97f934b999a6828693a99157fde912540cc"},
-    {file = "PyYAML-5.4.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:72a01f726a9c7851ca9bfad6fd09ca4e090a023c00945ea05ba1638c09dc3347"},
-    {file = "PyYAML-5.4.1-cp36-cp36m-manylinux2014_s390x.whl", hash = "sha256:895f61ef02e8fed38159bb70f7e100e00f471eae2bc838cd0f4ebb21e28f8541"},
     {file = "PyYAML-5.4.1-cp36-cp36m-win32.whl", hash = "sha256:3bd0e463264cf257d1ffd2e40223b197271046d09dadf73a0fe82b9c1fc385a5"},
     {file = "PyYAML-5.4.1-cp36-cp36m-win_amd64.whl", hash = "sha256:e4fac90784481d221a8e4b1162afa7c47ed953be40d31ab4629ae917510051df"},
     {file = "PyYAML-5.4.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:5accb17103e43963b80e6f837831f38d314a0495500067cb25afab2e8d7a4018"},
     {file = "PyYAML-5.4.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:e1d4970ea66be07ae37a3c2e48b5ec63f7ba6804bdddfdbd3cfd954d25a82e63"},
-    {file = "PyYAML-5.4.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:cb333c16912324fd5f769fff6bc5de372e9e7a202247b48870bc251ed40239aa"},
-    {file = "PyYAML-5.4.1-cp37-cp37m-manylinux2014_s390x.whl", hash = "sha256:fe69978f3f768926cfa37b867e3843918e012cf83f680806599ddce33c2c68b0"},
     {file = "PyYAML-5.4.1-cp37-cp37m-win32.whl", hash = "sha256:dd5de0646207f053eb0d6c74ae45ba98c3395a571a2891858e87df7c9b9bd51b"},
     {file = "PyYAML-5.4.1-cp37-cp37m-win_amd64.whl", hash = "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf"},
     {file = "PyYAML-5.4.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:d2d9808ea7b4af864f35ea216be506ecec180628aced0704e34aca0b040ffe46"},
     {file = "PyYAML-5.4.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:8c1be557ee92a20f184922c7b6424e8ab6691788e6d86137c5d93c1a6ec1b8fb"},
-    {file = "PyYAML-5.4.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:fd7f6999a8070df521b6384004ef42833b9bd62cfee11a09bda1079b4b704247"},
-    {file = "PyYAML-5.4.1-cp38-cp38-manylinux2014_s390x.whl", hash = "sha256:bfb51918d4ff3d77c1c856a9699f8492c612cde32fd3bcd344af9be34999bfdc"},
     {file = "PyYAML-5.4.1-cp38-cp38-win32.whl", hash = "sha256:fa5ae20527d8e831e8230cbffd9f8fe952815b2b7dae6ffec25318803a7528fc"},
     {file = "PyYAML-5.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:0f5f5786c0e09baddcd8b4b45f20a7b5d61a7e7e99846e3c799b05c7c53fa696"},
     {file = "PyYAML-5.4.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:294db365efa064d00b8d1ef65d8ea2c3426ac366c0c4368d930bf1c5fb497f77"},
     {file = "PyYAML-5.4.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:74c1485f7707cf707a7aef42ef6322b8f97921bd89be2ab6317fd782c2d53183"},
-    {file = "PyYAML-5.4.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:d483ad4e639292c90170eb6f7783ad19490e7a8defb3e46f97dfe4bacae89122"},
-    {file = "PyYAML-5.4.1-cp39-cp39-manylinux2014_s390x.whl", hash = "sha256:fdc842473cd33f45ff6bce46aea678a54e3d21f1b61a7750ce3c498eedfe25d6"},
     {file = "PyYAML-5.4.1-cp39-cp39-win32.whl", hash = "sha256:49d4cdd9065b9b6e206d0595fee27a96b5dd22618e7520c33204a4a3239d5b10"},
     {file = "PyYAML-5.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db"},
     {file = "PyYAML-5.4.1.tar.gz", hash = "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e"},
@@ -1484,10 +1444,6 @@ uvicorn = [
     {file = "uvicorn-0.13.4-py3-none-any.whl", hash = "sha256:7587f7b08bd1efd2b9bad809a3d333e972f1d11af8a5e52a9371ee3a5de71524"},
     {file = "uvicorn-0.13.4.tar.gz", hash = "sha256:3292251b3c7978e8e4a7868f4baf7f7f7bb7e40c759ecc125c37e99cdea34202"},
 ]
-verspec = [
-    {file = "verspec-0.1.0-py3-none-any.whl", hash = "sha256:741877d5633cc9464c45a469ae2a31e801e6dbbaa85b9675d481cda100f11c31"},
-    {file = "verspec-0.1.0.tar.gz", hash = "sha256:c4504ca697b2056cdb4bfa7121461f5a0e81809255b41c03dda4ba823637c01e"},
-]
 wrapt = [
     {file = "wrapt-1.12.1.tar.gz", hash = "sha256:b62ffa81fb85f4332a4f609cab4ac40709470da05643a082ec1eb88e6d9b97d7"},
 ]

pyproject.toml

@@ -43,9 +43,8 @@ asyncmy = "*"
 # docs
 mkdocs = "*"
 mkdocs-material = "*"
-mike = "*"
-mkdocs-static-i18n = "*"
 mkdocs-git-revision-date-localized-plugin = "*"
+mkdocs-markdownextradata-plugin = "*"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]