Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
Seedsa committed May 20, 2024
0 parents commit 8944e99
Show file tree
Hide file tree
Showing 273 changed files with 25,829 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
11 changes: 11 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
node_modules/
public/
es/
lib/
dist/
package.json
src/assets/
plop-templates/
handlebars/
website/
build/
30 changes: 30 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
module.exports = {
root: true,
parser: 'vue-eslint-parser',
globals: {
postMessage: true,
},
parserOptions: {
parser: '@typescript-eslint/parser',
sourceType: 'module',
ecmaFeatures: {
jsx: true,
tsx: true,
},
},
env: {
node: true,
// The Follow config only works with eslint-plugin-vue v8.0.0+
'vue/setup-compiler-macros': true,
},
extends: ['plugin:vue/vue3-essential', 'eslint:recommended'],
rules: {
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
'no-unused-vars': 'off',
'vue/no-unused-vars': 'off',
'vue/multi-word-component-names': 'off',
'vue/valid-template-root': 'off',
'vue/no-mutating-props': 'off',
},
}
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.DS_Store
node_modules
/dist
/lib

auto-imports.d.ts
components.d.ts

# local env files
.env.local
.env.*.local

# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
.env
4 changes: 4 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
shamefully-hoist = true
ignore-workspace-root-check = true
@tiptap-pro:registry=https://registry.tiptap.dev/
//registry.tiptap.dev/:_authToken=Gt/OzBETtPX4m+6ipi8qaYHgbEklaFd/HTBERN44XVEvLT+w1tbnIUV3Dlqcy8s0
10 changes: 10 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"printWidth": 120,
"singleQuote": true,
"trailingComma": "es5",
"bracketSpacing": true,
"useTabs": false,
"tabWidth": 2,
"semi": false,
"arrowParens": "avoid"
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 SEED

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
89 changes: 89 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Echo Editor

A modern WYSIWYG rich-text editor using tiptap for Vue.js

## Installation

Install with npm

```bash
npm install echo-editor
```

Or yarn

```bash
yarn add echo-editor
```

## Install Plugin

```javascript
import { createApp } from 'vue'
import './style.css'
import App from './App.vue'
import EchoEditor from 'echo-editor'
import 'echo-editor/lib/style.css'

const app = createApp(App)

app.use(EchoEditor)

app.mount('#app')
```

## Usage/Examples

```
import {
BaseKit,
} from 'echo-editor';
const extensions = [
BaseKit.configure({
placeholder: {
placeholder: '请输入...',
},
})]
<echo-editor
:extensions="extensions"
:max-height="465"
:min-height="300"
maxWidth="900"
/>
```

## Run Locally

Clone the project

```bash
git clone http://gogs.ltit.info/liji/echo-editor
```

Go to the project directory

```bash
cd echo-editor
```

Install dependencies

```bash
pnpm install
```

Start the Demo server

```bash
npm run dev
```

## Related

Here are some related projects

[Tiptap](https://tiptap.dev)

[Iconify](https://icon-sets.iconify.design)
89 changes: 89 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
const typeEnum = {
feat: {
description: '新功能',
title: 'Features',
emoji: '✨',
},
fix: {
description: 'BUG修复',
title: 'Bug Fixes',
emoji: '🐛',
},
docs: {
description: '文档变更',
title: 'Documentation',
emoji: '📚',
},
style: {
description: '代码样式美化(不影响代码运行的变动)',
title: 'Styles',
emoji: '💎',
},
refactor: {
description: '代码重构',
title: 'Code Refactoring',
emoji: '📦',
},
perf: {
description: '性能优化',
title: 'Performance Improvements',
emoji: '🚀',
},
test: {
description: '测试',
title: 'Tests',
emoji: '🚨',
},
revert: {
description: '回退',
title: 'Reverts',
emoji: '🗑',
},
chore: {
description: '构建/工程依赖/工具',
title: 'Chores',
emoji: '🚀',
},
}

module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'type-enum': [2, 'always', Object.keys(typeEnum)],
},
prompt: {
messages: {
skip: ':可选',
max: '最多 %d 个字符',
min: '最少 %d 个字符',
emptyWarning: '此项不能为空',
},
questions: {
type: {
description: '请选择提交类型',
enum: typeEnum,
},
scope: {
description: '请输入文件修改范围',
},
subject: {
description: '请简要描述提交',
},
body: {
description: '请输入详细描述',
},
isBreaking: {
description: '是否有任何重大变更?',
},
isIssueAffected: {
description: '此次变更是否影响打开的issues?',
},
issuesBody: {
description: '如果问题已解决,请输入解决的结果',
},
issues: {
description: '添加 issue 参考 (e.g. "fix #123", "re #123".)',
},
},
},
}
16 changes: 16 additions & 0 deletions components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"$schema": "https://shadcn-vue.com/schema.json",
"style": "new-york",
"typescript": true,
"tailwind": {
"config": "tailwind.config.js",
"css": "src/styles/global.scss",
"baseColor": "zinc",
"cssVariables": true
},
"framework": "vite",
"aliases": {
"components": "@/components",
"utils": "@/utils"
}
}
3 changes: 3 additions & 0 deletions examples/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

# Your OPEN AI API KEY
VITE_OPENAI_API_KEY=''
Loading

0 comments on commit 8944e99

Please sign in to comment.