Skip to content

Commit

Permalink
feat: 🎉 Initialization
Browse files Browse the repository at this point in the history
  • Loading branch information
viarotel committed Nov 19, 2023
1 parent 75f2636 commit 9ba911c
Show file tree
Hide file tree
Showing 25 changed files with 4,970 additions and 123 deletions.
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.gitignore
node_modules
dist
16 changes: 16 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
module.exports = {
extends: ['@viarotel-org'],
rules: {
'no-unused-vars': 'off',
'eqeqeq': 'off',
'prefer-promise-reject-errors': 'off',
'no-new-func': 'off',

'antfu/top-level-function': 'off',

'import/default': 'off',

'vue/no-mutating-props': 'off',
'vue/no-use-v-if-with-v-for': 'off',
},
}
35 changes: 35 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main

permissions:
contents: write

jobs:
build-and-deploy:
concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v3

- name: Install pnpm 📥
uses: pnpm/action-setup@v2
with:
version: 8
run_install: |
args: []
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
run: |
pnpm install
pnpm build
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: docs
folder: dist
20 changes: 20 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: release-please

on:
push:
branches:
- main

permissions:
contents: write
pull-requests: write

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: google-github-actions/release-please-action@v3
with:
release-type: node
package-name: release-please-action
token: ${{ secrets.ACCESS_TOKEN }}
20 changes: 20 additions & 0 deletions .github/workflows/sync-gitee.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: sync-gitee
on:
workflow_dispatch: {}
push:
branches:
- main
jobs:
sync-to-gitee:
runs-on: ubuntu-latest
steps:
- name: gitee-mirror-action
uses: Yikun/hub-mirror-action@master
with:
src: github/viarotel-org
dst: gitee/viarotel-org
dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}
dst_token: ${{ secrets.GITEE_TOKEN }}
account_type: org
white_list: 'markvite'
force_update: true
136 changes: 15 additions & 121 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,127 +4,21 @@ logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
node_modules
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
4 changes: 4 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
registry=https://registry.npmmirror.com/
ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/
shamefully-hoist=true
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
}
4 changes: 4 additions & 0 deletions .yarnrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1

registry "https://registry.npmmirror.com/"
73 changes: 73 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Markvite [WIP]

> 使用 Web 扩展和增强 Markdown 语法
## 特色

1. 🔧 自定义:使用 Web 技术扩展 Markdown 语法,并支持导入 Vue 组件,满足用户个性化需求,扩展功能和样式。
2. 📂 便携性:生成单个 HTML 和 PDF 文件,方便分享和传播,无需额外软件或依赖。
3. 🌓 主题:支持浅色和深色模式,提供舒适的阅读体验和个性化选择。
4. ⚡️ 开发效率:采用 Vite 作为现代化前端构建工具和开发服务器,快速高效地进行开发。
5. 🎨 样式:使用 Unocss,原子化 CSS 引擎,简化样式管理,提高代码复用性,同时减小项目文件大小。

## 快速上手

1. 克隆项目

```shell
git clone https://github.com/viarotel-org/markvite.git
```

2. 安装依赖

```shell
npm install
```

3. 运行项目

```shell
npm run dev
```

4. 构建生产版本

```shell
npm run build
```

## 常见问题

暂无

## 获得帮助

> 因为是开源项目 全靠爱发电 所以支持有限 更新节奏不固定
>
> 注意:非 BUG 或计划外的需求,有偿处理;至于金额,根据问题难易程度,你觉得帮助了多少,看着给吧(维护这些项目已经耗费了大量精力,还要免费花时间解答问题就说不过去了吧...所以白嫖的一律不通过。)
- issues: [反馈问题](https://github.com/viarotel-org/escrcpy/issues)
- email: [email protected]
- weixin: viarotel
- qq: 523469508

## 致谢

该项目的诞生离不开以下开源项目

- [vite](https://vitejs.dev)
- [vue](https://vuejs.org)
- [github-markdown-css](https://github.com/sindresorhus/github-markdown-css)
- [vite-plugin-singlefile](https://github.com/richardtallent/vite-plugin-singlefile)
- [unplugin-vue-markdown](https://github.com/unplugin/unplugin-vue-markdown)
- [electron-pdf](https://github.com/fraserxu/electron-pdf)
- [unocss](https://unocss.dev)

## 支持项目

> 如果该项目帮到你的话,可以请我喝杯咖啡,让我更有精神完善该项目 😛
<div style="display:flex;">
<img src="https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/79dcbc40246743e2b6870419e88e0392~tplv-k3u1fbpfcp-watermark.image?" alt="viarotel-wepay" style="width: 30%;">
<img src="https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/1e5e69b83dd746deade95afd4a6864ec~tplv-k3u1fbpfcp-watermark.image?" alt="viarotel-alipay" style="width: 30%;">
</div>
Loading

0 comments on commit 9ba911c

Please sign in to comment.