docs: 文档网站
This commit is contained in:
liuweiqing
parent
762601f308
commit
4c52a20524
|
|
@ -1,16 +0,0 @@
|
|||
{
|
||||
"env": {
|
||||
"browser": true,
|
||||
"es2021": true,
|
||||
"node": true
|
||||
},
|
||||
"extends": ["google", "plugin:vue/vue3-essential"],
|
||||
"parserOptions": {
|
||||
"ecmaVersion": "latest",
|
||||
"sourceType": "module"
|
||||
},
|
||||
"plugins": ["vue"],
|
||||
"rules": {
|
||||
"quotes": ["error", "single"]
|
||||
}
|
||||
}
|
||||
12
docs/docs/.gitignore
vendored
12
docs/docs/.gitignore
vendored
|
|
@ -1,12 +0,0 @@
|
|||
pids
|
||||
logs
|
||||
node_modules
|
||||
npm-debug.log
|
||||
coverage/
|
||||
run
|
||||
dist
|
||||
.DS_Store
|
||||
.nyc_output
|
||||
.basement
|
||||
config.local.js
|
||||
basement_dist
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
{
|
||||
"semi": false,
|
||||
"singleQuote": true,
|
||||
"endOfLine": "auto"
|
||||
}
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
{
|
||||
"name": "paperai-docs",
|
||||
"version": "0.0.1",
|
||||
"description": "docs and usage of paperai",
|
||||
"main": "index.js",
|
||||
"authors": {
|
||||
"name": "liuweiqing",
|
||||
"email": "liuweiqing147@gmail.com"
|
||||
},
|
||||
"repository": "/paperai-docs",
|
||||
"scripts": {
|
||||
"dev": "vuepress dev src",
|
||||
"build": "vuepress build src"
|
||||
},
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"eslint": ">=5.16.0",
|
||||
"eslint-config-google": "^0.14.0",
|
||||
"eslint-plugin-vue": "^9.21.1",
|
||||
"vuepress": "^1.5.3"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<template>
|
||||
<p class="demo">
|
||||
{{ msg }}
|
||||
</p>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
data () {
|
||||
return {
|
||||
msg: 'Hello this is <Foo-Bar>'
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
<template>
|
||||
<p class="demo">This is another component</p>
|
||||
</template>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<template>
|
||||
<p class="demo">
|
||||
{{ msg }}
|
||||
</p>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
msg: 'Hello this is <demo-component>'
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
|
@ -1,71 +0,0 @@
|
|||
const { description } = require('../../package')
|
||||
|
||||
module.exports = {
|
||||
/**
|
||||
* Ref：https://v1.vuepress.vuejs.org/config/#title
|
||||
*/
|
||||
title: 'docs of paperai',
|
||||
/**
|
||||
* Ref：https://v1.vuepress.vuejs.org/config/#description
|
||||
*/
|
||||
description: description,
|
||||
|
||||
/**
|
||||
* Extra tags to be injected to the page HTML `<head>`
|
||||
*
|
||||
* ref：https://v1.vuepress.vuejs.org/config/#head
|
||||
*/
|
||||
head: [
|
||||
['meta', { name: 'theme-color', content: '#3eaf7c' }],
|
||||
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
|
||||
[
|
||||
'meta',
|
||||
{ name: 'apple-mobile-web-app-status-bar-style', content: 'black' },
|
||||
],
|
||||
],
|
||||
|
||||
/**
|
||||
* Theme configuration, here is the default theme configuration for VuePress.
|
||||
*
|
||||
* ref：https://v1.vuepress.vuejs.org/theme/default-theme-config.html
|
||||
*/
|
||||
themeConfig: {
|
||||
repo: '',
|
||||
editLinks: false,
|
||||
docsDir: '',
|
||||
editLinkText: '',
|
||||
lastUpdated: false,
|
||||
nav: [
|
||||
{
|
||||
text: 'Guide',
|
||||
link: '/guide/',
|
||||
},
|
||||
{
|
||||
text: 'Config',
|
||||
link: '/config/',
|
||||
},
|
||||
{
|
||||
text: 'GitHub',
|
||||
link: 'https://github.com/14790897/paper-ai',
|
||||
},
|
||||
],
|
||||
sidebar: {
|
||||
'/guide/': [
|
||||
{
|
||||
title: 'Guide2',
|
||||
collapsable: false,
|
||||
children: [
|
||||
'',
|
||||
'paperai-deploy',
|
||||
'env'
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/
|
||||
*/
|
||||
plugins: ['@vuepress/plugin-back-to-top', '@vuepress/plugin-medium-zoom'],
|
||||
}
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
/**
|
||||
* Client app enhancement file.
|
||||
*
|
||||
* https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
|
||||
*/
|
||||
|
||||
export default ({
|
||||
Vue, // the version of Vue being used in the VuePress app
|
||||
options, // the options for the root Vue instance
|
||||
router, // the router instance for the app
|
||||
siteData // site metadata
|
||||
}) => {
|
||||
// ...apply enhancements for the site.
|
||||
}
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
/**
|
||||
* Custom Styles here.
|
||||
*
|
||||
* ref：https://v1.vuepress.vuejs.org/config/#index-styl
|
||||
*/
|
||||
|
||||
.home .hero img
|
||||
max-width 450px!important
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
/**
|
||||
* Custom palette here.
|
||||
*
|
||||
* ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
|
||||
*/
|
||||
|
||||
$accentColor = #3eaf7c
|
||||
$textColor = #2c3e50
|
||||
$borderColor = #eaecef
|
||||
$codeBgColor = #282c34
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
sidebar: auto
|
||||
---
|
||||
|
||||
# Config
|
||||
|
||||
## foo
|
||||
|
||||
- Type: `string`
|
||||
- Default: `/`
|
||||
|
||||
## bar
|
||||
|
||||
- Type: `string`
|
||||
- Default: `/`
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
---
|
||||
title: 介绍
|
||||
sidebar: auto
|
||||
---
|
||||
|
||||
# 介绍
|
||||
|
||||
## 功能
|
||||
|
||||
### 利用人工智能撰写论文
|
||||
|
||||
- **人工智能书写功能**： 点击 "AI 写作 "进行正常对话互动。人工智能将根据您的输入提供写作建议或回答问题。
|
||||
|
||||
- **寻找文献功能**： 点击 "寻找文献"，根据输入的关键词在Semantic Scholar或arxiv或PubMed中搜索论文。系统将把信息整合到您的论文中。一次搜索两篇，无搜索结果时会显示错误提示。
|
||||
|
||||
- **内置多个免费AI模型**：请在右上角设置界面查看
|
||||
|
||||
- **云同步及多篇论文编辑功能**：此功能暂定收费二十元人民币永久开通，请点击左上角列表按钮进行购买
|
||||
|
||||
### 编辑和修改
|
||||
|
||||
- 在编辑器中直接编辑和修改人工智能生成的内容。
|
||||
|
||||
- 使用提供的工具调整文本样式和布局。
|
||||
|
||||
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
|
||||
## 环境变量说明
|
||||
|
||||
1. NEXT_PUBLIC_OPENAI_API_KEY 设置key，只要在设置界面（右上角齿轮）对应的位置留空就会使用预定的变量
|
||||
2. NEXT_PUBLIC_AI_URL 设置上游url，只要在设置界面（右上角齿轮）对应的位置留空就会使用预定的变量
|
||||
3. NEXT_PUBLIC_SEMANTIC_API_KEY 设置semantic scholar的key，可以增加请求量
|
||||
4. NEXT_PUBLIC_PUBMED_API_KEY 设置pubmed的key，可以增加请求量
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
|
||||
|
||||
## 部署方法
|
||||
|
||||
## 镜像运行
|
||||
1. 拉取镜像
|
||||
```sh
|
||||
docker pull 14790897/paperai:latest
|
||||
```
|
||||
2. 运行镜像
|
||||
```sh
|
||||
docker run -d -p 3000:3000 \
|
||||
-e NEXT_PUBLIC_AI_URL=自定义AI模型地址\
|
||||
-e NEXT_PUBLIC_OPENAI_API_KEY=自定义API KEY \
|
||||
14790897/paperai:latest
|
||||
```
|
||||
|
||||
## vercel部署
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https://github.com/14790897/paper-ai&project-name=paper-ai&repository-name=paper-ai&demo-title=paper-ai&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fpaperai.life%2Fopengraph-image.png)
|
||||
|
||||
|
||||
## 克隆在本地运行
|
||||
|
||||
```bash
|
||||
# 克隆版本库
|
||||
git clone https://github.com/14790897/paper-ai.git
|
||||
|
||||
# 进入项目目录
|
||||
cd paper-ai
|
||||
|
||||
# 安装依赖项
|
||||
npm install
|
||||
|
||||
# 运行项目
|
||||
npm run dev
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
home: true
|
||||
# heroImage: https://v1.vuepress.vuejs.org/hero.png
|
||||
tagline: docs and usage of paperai
|
||||
actionText: Quick Start →
|
||||
actionLink: /guide/
|
||||
features:
|
||||
- title: Feature 1 使用真实文献
|
||||
details: 从各种文献网站获取真实文献
|
||||
- title: Feature 2 AI写作
|
||||
details: 内置免费AI模型
|
||||
- title: Feature 3 文献管理
|
||||
details: 将文献有序地排列
|
||||
footer: Made by liuweiqing with ❤️
|
||||
---
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
{
|
||||
"engines": {
|
||||
"node": "21.5"
|
||||
}
|
||||
}
|
||||
9328
docs/docs/yarn.lock
9328
docs/docs/yarn.lock
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user