doc: update docs

This commit is contained in:
Michael Yang 2024-06-28 16:52:44 +08:00
parent d03b0f5951
commit 9acfc86067
12 changed files with 572 additions and 17 deletions

View File

@ -0,0 +1,3 @@
<template>
<svg style="fill:#646cff" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M9.9997 15.1709L19.1921 5.97852L20.6063 7.39273L9.9997 17.9993L3.63574 11.6354L5.04996 10.2212L9.9997 15.1709Z"></path></svg>
</template>

View File

@ -0,0 +1,3 @@
<template>
<svg style="fill: red" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M11.9997 10.5865L16.9495 5.63672L18.3637 7.05093L13.4139 12.0007L18.3637 16.9504L16.9495 18.3646L11.9997 13.4149L7.04996 18.3646L5.63574 16.9504L10.5855 12.0007L5.63574 7.05093L7.04996 5.63672L11.9997 10.5865Z"></path></svg>
</template>

View File

@ -57,6 +57,12 @@ const {Layout} = DefaultTheme
</div>
</template>
<template #home-hero-image>
<div style="z-index: 9999" >
<img src="/assets/image/index-banner.png">
</div>
</template>
<!-- <template #home-features-after>-->
<!-- <div class="banner-home">-->
<!-- <a href="https://aiadmin.cc" target="_blank">-->

View File

@ -0,0 +1,76 @@
<template>
<div class="question">
<div class="title">{{ title }}
<button @click="onClick" :class="open ? 'active': ''">
<svg v-if="open" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor">
<path d="M5 11V13H19V11H5Z"></path>
</svg>
<svg v-else xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor">
<path d="M11 11V5H13V11H19V13H13V19H11V13H5V11H11Z"></path>
</svg>
</button>
</div>
<div v-if="open" class="content">
{{ content }}
</div>
</div>
</template>
<script lang="ts" setup>
import {ref} from 'vue';
defineProps(['title', 'content'])
const open = ref(false);
const onClick = () => {
open.value = !open.value
}
</script>
<style scoped>
.question {
background: #f8f9fa;
padding: 20px;
border-radius: 5px;
}
.title {
display: flex;
justify-content: space-between;
align-items: center;
color: #000000;
font-weight: bold;
font-size: 16px;
}
button {
background: #eee;
display: flex;
justify-content: center;
align-content: center;
width: 26px;
height: 26px;
border-radius: 6px;
}
.active {
background: #3e63dd;
}
.active svg {
fill: #fff;
}
svg {
height: 26px;
width: 26px;
fill: #999;
}
.content {
color: #999;
margin: 10px 30px 0 0;
}
</style>

View File

@ -1,13 +1,18 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import {h} from 'vue'
import Theme from 'vitepress/theme'
import './style.css'
import MyLayout from "./MyLayout.vue";
import Check from "./Check.vue";
import Question from "./Question.vue";
import Close from "./Close.vue";
export default {
...Theme,
Layout: MyLayout,
enhanceApp({ app, router, siteData }) {
// ...
}
...Theme,
Layout: MyLayout,
enhanceApp({app, router, siteData}) {
app.component('Check', Check)
app.component('Close', Close)
app.component('Question', Question)
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 425 KiB

90
docs/contact-us.md Normal file
View File

@ -0,0 +1,90 @@
---
layout: home
#sidebar: false
#aside: false
---
<style>
.VPHome{
border-top: 1px solid #eee;
}
.VPHome svg{
width: 24px;
display: inline-block;
margin: 0 5px;
}
.h1,h2,h3,h4{
display: flex;
align-items: center;
justify-content: center;
}
.wechat {
text-align: center;
}
.wechat img{
width: 200px;
display: inline-block;
}
.other{
padding: 20px;
}
.other svg{
fill: #333;
width: 30px;
}
</style>
<div style="text-align: center;padding: 60px 0 30px;">
# 联系我们
<div style="color: #999;margin: 40px">
嗨,我是 Jenny`AiEditor` 联合创始人。 <br >
您可以跟我分享使用 AiEditor 的故事; <br >
也可以向我了解商业版本的更多信息; <br >
还可以跟我探讨合作的可能性... <br >
期待您通过下面方式,与我取得联系。 <br >
</div>
### <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M3 3H21C21.5523 3 22 3.44772 22 4V20C22 20.5523 21.5523 21 21 21H3C2.44772 21 2 20.5523 2 20V4C2 3.44772 2.44772 3 3 3ZM20 7.23792L12.0718 14.338L4 7.21594V19H20V7.23792ZM4.51146 5L12.0619 11.662L19.501 5H4.51146Z"></path></svg> 我的邮箱
<a href="mailto:ennyzhou7799@gmail.com" style="text-decoration: none">
`jennyzhou7799@gmail.com`
</a>
### <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M18.5753 13.7114C19.0742 13.7114 19.4733 13.2873 19.4733 12.8134C19.4733 12.3145 19.0742 11.9155 18.5753 11.9155C18.0765 11.9155 17.6774 12.3145 17.6774 12.8134C17.6774 13.3123 18.0765 13.7114 18.5753 13.7114ZM14.1497 13.7114C14.6485 13.7114 15.0476 13.2873 15.0476 12.8134C15.0476 12.3145 14.6485 11.9155 14.1497 11.9155C13.6508 11.9155 13.2517 12.3145 13.2517 12.8134C13.2517 13.3123 13.6508 13.7114 14.1497 13.7114ZM20.717 18.7516C20.5942 18.8253 20.5205 18.9482 20.5451 19.1202C20.5451 19.1693 20.5451 19.2185 20.5696 19.2676C20.6679 19.6854 20.8643 20.349 20.8643 20.3736C20.8643 20.4473 20.8889 20.4964 20.8889 20.5456C20.8889 20.6685 20.7907 20.7668 20.6679 20.7668C20.6187 20.7668 20.5942 20.7422 20.5451 20.7176L19.0961 19.882C18.9978 19.8329 18.875 19.7837 18.7522 19.7837C18.6786 19.7837 18.6049 19.7837 18.5558 19.8083C17.8681 20.0049 17.1559 20.1032 16.3946 20.1032C12.7352 20.1032 9.78815 17.6456 9.78815 14.5983C9.78815 11.5509 12.7352 9.09329 16.3946 9.09329C20.0539 9.09329 23.001 11.5509 23.001 14.5983C23.001 16.2448 22.1168 17.7439 20.717 18.7516ZM16.6737 8.09757C16.581 8.09473 16.488 8.09329 16.3946 8.09329C12.2199 8.09329 8.78815 10.9536 8.78815 14.5983C8.78815 15.1519 8.86733 15.6874 9.01626 16.1975H8.92711C8.04096 16.1975 7.15481 16.0503 6.3425 15.8296C6.26866 15.805 6.19481 15.805 6.12097 15.805C5.97327 15.805 5.82558 15.8541 5.7025 15.9277L3.95482 16.9334C3.90559 16.958 3.85635 16.9825 3.80712 16.9825C3.65943 16.9825 3.53636 16.8599 3.53636 16.7127C3.53636 16.6391 3.56097 16.59 3.58559 16.5164C3.6102 16.4919 3.83174 15.6824 3.95482 15.1918C3.95482 15.1427 3.97943 15.0691 3.97943 15.0201C3.97943 14.8238 3.88097 14.6766 3.75789 14.5785C2.05944 13.3765 1.00098 11.5858 1.00098 9.59876C1.00098 5.94369 4.5702 3 8.95173 3C12.7157 3 15.8802 5.16856 16.6737 8.09757ZM11.5199 8.51604C12.0927 8.51604 12.5462 8.03871 12.5462 7.4898C12.5462 6.91701 12.0927 6.46356 11.5199 6.46356C10.9471 6.46356 10.4937 6.91701 10.4937 7.4898C10.4937 8.06258 10.9471 8.51604 11.5199 8.51604ZM6.26045 8.51604C6.83324 8.51604 7.28669 8.03871 7.28669 7.4898C7.28669 6.91701 6.83324 6.46356 6.26045 6.46356C5.68767 6.46356 5.23421 6.91701 5.23421 7.4898C5.23421 8.06258 5.68767 8.51604 6.26045 8.51604Z"></path></svg> 微信
<div class="wechat">
![](/assets/image/wechat-jenny.png)
</div>
### 其他
<div class="other">
<a href="">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M22.2125 5.65605C21.4491 5.99375 20.6395 6.21555 19.8106 6.31411C20.6839 5.79132 21.3374 4.9689 21.6493 4.00005C20.8287 4.48761 19.9305 4.83077 18.9938 5.01461C18.2031 4.17106 17.098 3.69303 15.9418 3.69434C13.6326 3.69434 11.7597 5.56661 11.7597 7.87683C11.7597 8.20458 11.7973 8.52242 11.8676 8.82909C8.39047 8.65404 5.31007 6.99005 3.24678 4.45941C2.87529 5.09767 2.68005 5.82318 2.68104 6.56167C2.68104 8.01259 3.4196 9.29324 4.54149 10.043C3.87737 10.022 3.22788 9.84264 2.64718 9.51973C2.64654 9.5373 2.64654 9.55487 2.64654 9.57148C2.64654 11.5984 4.08819 13.2892 6.00199 13.6731C5.6428 13.7703 5.27232 13.8194 4.90022 13.8191C4.62997 13.8191 4.36771 13.7942 4.11279 13.7453C4.64531 15.4065 6.18886 16.6159 8.0196 16.6491C6.53813 17.8118 4.70869 18.4426 2.82543 18.4399C2.49212 18.4402 2.15909 18.4205 1.82812 18.3811C3.74004 19.6102 5.96552 20.2625 8.23842 20.2601C15.9316 20.2601 20.138 13.8875 20.138 8.36111C20.138 8.1803 20.1336 7.99886 20.1256 7.81997C20.9443 7.22845 21.651 6.49567 22.2125 5.65605Z"></path></svg>
</a>
<a href="">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M4.00098 3H20.001C20.5533 3 21.001 3.44772 21.001 4V20C21.001 20.5523 20.5533 21 20.001 21H4.00098C3.44869 21 3.00098 20.5523 3.00098 20V4C3.00098 3.44772 3.44869 3 4.00098 3ZM5.00098 5V19H19.001V5H5.00098ZM7.50098 9C6.67255 9 6.00098 8.32843 6.00098 7.5C6.00098 6.67157 6.67255 6 7.50098 6C8.3294 6 9.00098 6.67157 9.00098 7.5C9.00098 8.32843 8.3294 9 7.50098 9ZM6.50098 10H8.50098V17.5H6.50098V10ZM12.001 10.4295C12.5854 9.86534 13.2665 9.5 14.001 9.5C16.072 9.5 17.501 11.1789 17.501 13.25V17.5H15.501V13.25C15.501 12.2835 14.7175 11.5 13.751 11.5C12.7845 11.5 12.001 12.2835 12.001 13.25V17.5H10.001V10H12.001V10.4295Z"></path></svg>
</a>
</div>
</div>

5
docs/env.d.ts vendored Normal file
View File

@ -0,0 +1,5 @@
declare module "*.vue" {
import { DefineComponent } from "vue"
const component: DefineComponent<{}, {}, any>
export default component
}

View File

@ -3,15 +3,15 @@
layout: home
hero:
name: "AiEditor"
text: a next-generation rich text editor for AI
name: "AIEditor"
text: a next-gen rich text editor for AI
tagline: Out-of-the-box, Fully Framework Supported, Markdown Friendly
image:
src: /assets/image/logo-large.png
src: /assets/image/index-banner.png
alt: AiEditor
actions:
- theme: brand
text: Quick Start
text: Quick Start
link: /getting-started
- theme: alt
text: Live Preview
@ -19,12 +19,207 @@ hero:
features:
- title: Lightweight
details: AiEditor is ready to use out of the box, Development based on Web Components, and does not depend on any rendering framework such as VUE, React or Angular, making it compatible with almost any framework.
- title: Intelligent
details: AiEditor supports AI continuation, AI optimization, AI proofreading, AI translation, and custom AI menus with their respective Prompts. It supports integration with models like ChatGPT, Spark and private LLMs.
- title: Powerful
details: In addition to basic functions, AiEditor also supports features that many top editors do not have, such as format painting, merging and unmerging of cells, light and dark themes, mobile adaptation, and more.
#features:
# - title: Lightweight
# details: AiEditor is ready to use out of the box, Development based on Web Components, and does not depend on any rendering framework such as VUE, React or Angular, making it compatible with almost any framework.
# - title: Intelligent
# details: AiEditor supports AI continuation, AI optimization, AI proofreading, AI translation, and custom AI menus with their respective Prompts. It supports integration with models like ChatGPT, Spark and private LLMs.
# - title: Powerful
# details: In addition to basic functions, AiEditor also supports features that many top editors do not have, such as format painting, merging and unmerging of cells, light and dark themes, mobile adaptation, and more.
---
<style >
.VPHome svg{
width: 24px;
display: inline-block;
margin: 0 5px;
}
.VPContent> .VPHome {
margin-bottom: 0;
}
.VPContent> .VPHome> .container{
width: 100% !important;
padding: 0 !important;
margin: 0 !important;
max-width: 100%;
}
.VPContent> .VPHome> .container .feature{
text-align: center;
margin: 40px;
}
.VPContent> .VPHome> .container .feature p{
color: #999;
}
.VPContent> .VPHome> .vp-doc table{
display: inline-block;
background: none;
}
.VPContent> .VPHome> .vp-doc table th{
background: none;
border: none;
}
.VPContent> .VPHome> .vp-doc thead tr :not(:first-child){
border-bottom: solid 1px #ccc;
margin: 10px;
font-weight: bold;
font-size: 16px;
}
.VPContent> .VPHome> .vp-doc table tr{
background: none;
border: none;
}
.VPContent> .VPHome> .vp-doc table tr{
height: 40px;
}
.VPContent> .VPHome> .vp-doc table tbody tr:first-child{
height: 20px;
}
.VPContent> .VPHome> .vp-doc table td{
background: none;
border: none;
}
.VPContent> .VPHome> .vp-doc table td svg{
margin: -7px 0;
}
.VPContent> .VPHome> .vp-doc table td:nth-of-type(2) svg{
fill: red;
}
.VPContent> .VPHome> .vp-doc table td:nth-of-type(3) svg{
fill: #646cff;
}
</style>
<div style="text-align: center;background-color: #f8f9fa;padding: 80px">
# 为什么选择 `AIEditor`
<div style="margin: 30px 0 40px;color: #999">
相较于使用其他,只有选择 AiEditor您才会拥有一款真正属于自己的富文本编辑器。
</div>
| | 其他编辑器(没有源码,按量付费) | AiEditor(真正属于自己) |
| ------------- |:-----------------|:-----------------------------------------------|
| |
| 私有化部署 | ☹️ 不支持或需要高昂费用 | <Check /> 开源版和商业版都支持私有化部署,保证数据和隐私安全 |
| 大模型支持 | ☹️ 只支持 2/3 种 | <Check /> 支持接入市面上任意大模型,包括私有大模型 |
| 私有 APlkey | ☹️ 不支持 | <Check /> 支持,保证数据隐私安全,把控自己的消费 |
| 数据绑架 | ☹️ 按用户数量和应用收费 | <Check /> 无论开源版还是商业版,不限制用户数量,不限制应用数量 |
</div>
<div class="feature">
# 特性
相较于使用其他,只有选择 AiEditor您才会拥有一款真正属于自己的富文本编辑器。
</div>
<div style="display: flex;justify-content: center">
<div style="display: flex;padding: 20px 0;max-width: 1280px">
<div style="width: 50%">
![](/assets/image/feature1.png)
</div>
<div style="width: 50%;padding: 50px">
<h1>多人协作</h1>
多人协作允许多个用户同时在同一文档上工作,团队成员能实时看到其他人的输入和更改。适用于软件开发、市场营销、法律文件审查、项目管理、教学、新闻报道、医疗研究等等场景。
</div>
</div>
</div>
<div style="display: flex;justify-content: center">
<div style="display: flex;padding: 20px 0;max-width: 1280px">
<div style="width: 50%;padding: 50px">
<h1>多人协作</h1>
多人协作允许多个用户同时在同一文档上工作,团队成员能实时看到其他人的输入和更改。适用于软件开发、市场营销、法律文件审查、项目管理、教学、新闻报道、医疗研究等等场景。
</div>
<div style="width: 50%">
![](/assets/image/feature1.png)
</div>
</div>
</div>
<div style="text-align: center;background-color: #f8f9fa;padding: 80px">
# 你准备好了吗?
<div style="margin: 30px 0 40px;color: #999">
接下来,无论你使用开源版,还是商业版,都会收获惊喜!
</div>
<div style="display: flex;justify-content: center">
<div style="display: flex;padding: 20px 0;max-width: 1280px">
<div style="width: 440px;background: #eeeff0;padding: 20px;border-radius: 5px;margin-right: 15px">
开源版<br />
<button style="background: #1b1b1f;color: #fff;padding: 10px 50px;border-radius: 5px;font-weight: bold;font-size: 14px;margin: 20px 0 40px 0">试用一下</button>
<div style="font-size: 12px">
AiEditor 基于更为宽松的 LGPL 协议开源<br />
不限制用户数量<br />
不限制应用数量
</div>
</div>
<div style="width: 440px;background: #eeeff0;padding: 20px;border-radius: 5px;margin-left: 15px">
开源版<br />
<button style="background: #1b1b1f;color: #fff;padding: 10px 50px;border-radius: 5px;font-weight: bold;font-size: 14px;margin: 20px 0 40px 0">试用一下</button>
<div style="font-size: 12px">
AiEditor 基于更为宽松的 LGPL 协议开源<br />
不限制用户数量<br />
不限制应用数量
</div>
</div>
</div>
</div>
</div>

172
docs/versions.md Normal file
View File

@ -0,0 +1,172 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home
---
<style scoped>
.VPHome svg{
width: 24px;
display: inline-block;
margin: 0 5px;
}
.VPContent> .VPHome {
margin-bottom: 0;
}
.VPContent> .VPHome> .container{
width: 100% !important;
padding: 0 !important;
margin: 0 !important;
max-width: 100%;
}
.VPContent> .VPHome> .container .feature{
text-align: center;
margin: 40px;
}
.VPContent> .VPHome> .container .feature p{
color: #999;
}
.VPContent> .VPHome> .vp-doc table{
display: table;
background: none;
width: 100%;
table-layout: fixed;
overflow-wrap: break-word;
}
.VPContent> .VPHome> .vp-doc table th{
background: none;
border: none;
}
.VPContent> .VPHome> .vp-doc thead tr :not(:first-child){
margin: 10px;
font-weight: bold;
font-size: 16px;
}
.VPContent> .VPHome> .vp-doc table tr{
background: none;
border: none;
border-bottom: 1px solid #eee;
}
.VPContent> .VPHome> .vp-doc table tr{
height: 40px;
}
.VPContent> .VPHome> .vp-doc table tbody tr:first-child{
height: 20px;
}
.VPContent> .VPHome> .vp-doc table td{
background: none;
border: none;
}
.VPContent> .VPHome> .vp-doc table td:first-child{
color: #999;
}
.VPContent> .VPHome> .vp-doc table td:first-child strong{
color: #333;
font-size: 14px;
}
.VPContent> .VPHome> .vp-doc table td svg{
margin: -7px 0;
}
</style>
<div class="feature" style="margin-top: 80px">
# 商业许可证和商业插件
当你的企业在商业模式和技术支持等方面有更高要求时,可以选择商业许可证。
</div>
<div style="display: flex;justify-content: center">
<div style="display: flex;padding: 20px 0;max-width: 1280px">
| | 社区版 | 专业版 | 企业版 |
|---------------|:---------:|:-----------:|:------:|
| 价格 | 免费 | 联系我们 | 联系我们 |
| **许可证** |
| 许可证类型 | LGPL | 商业许可证 | 商业许可证 |
| 永久授权 | <Check /> | <Check /> | <Check /> |
| 授权版本 | 全部 | 一个根版本 | 一个根版本 |
| **使用限制** |
| 授权版本 | 全部 | 一个根版本 | 一个根版本 |
| 不限制用户数量 | <Check /> | <Check /> | <Check /> |
| 不限制应用数量 | <Check /> | <Check /> | <Check /> |
| 不限制数据量 | <Check /> | <Check /> | <Check /> |
| 开发商业应用 | <Close /> | <Check /> | <Check /> |
| 保持你自己的代码不开源 | <Close /> | <Check /> | <Check /> |
| 在界面上使用自己的品牌信息 | <Close /> | <Check /> | <Check /> |
| **支持** |
| 社区支持 | <Check /> | <Check /> | <Check /> |
| 专属和及时的 bug 修复 | <Close /> | <Check /> | <Check /> |
</div>
</div>
<div class="feature">
# 常见问题
</div>
<div style="display: flex;justify-content: center">
<div style="display: flex;padding: 20px 0;max-width: 1280px;width: 100vw">
<div style="width: 50%;margin-right: 15px">
<Question title="AlAdmin 包含了哪些权利?" content="不是。AiEditor 的内核是LGPL协议只要你遵循协议并且保留界面上的 AiEditor 版权信息和版本信息,就可以免费使用。" />
</div>
<div style="width: 50%; margin-left: 15px">
<Question title="什么情况下需要购买商业许可证?" content="当你的企业在商业模式和技术支持等方面有更高要求时,可以选择商业许可证。当你的企业在商业模式和技术支持等方面有更高要求时,可以选择商业许可证。当你的企业在商业模式和技术支持等方面有更高要求时,可以选择商业许可证。" />
</div>
</div>
</div>
<div class="feature">
# 购买
通过邮件或微信联系我们,与我们的核心团队探讨方案,获得独家支持。
<button style="background: #1b1b1f;color: #fff;padding: 10px 50px;border-radius: 5px;font-weight: bold;font-size: 14px;margin: 20px 0 40px 0">
联系我们
</button>
</div>