Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EDU-5631] feat-new-vuepress-readme-files #205

Merged
merged 3 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 28 additions & 29 deletions templates/vuepress/vuepress-boilerplate/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,32 @@
# VuePress Boilerplate

With the **VuePress Boilerplate** template, you can start a project using the [VuePress](https://vuepress.vuejs.org/guide/introduction.html) framework and deploy it to the edge in a few steps. The template also creates a GitHub repository containing your project, an edge application, and a domain to facilitate your access and management through the Azion Edge Platform.

VuePress is a Markdown-centered static site generator that allows developers to write content (documentation, blogs, etc.) in Markdown and generates a static site to host it.

This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy the VuePress Boilerplate](https://www.azion.com/en/documentation/products/guides/vuepress-boilerplate/) guide.

This template uses VuePress version `2.0.0`.

---
home: true
title: Home
heroImage: https://vuejs.press/images/hero.png
actions:
- text: Get Started
link: /get-started.html
type: primary

- text: Introduction
link: https://vuejs.press/guide/introduction.html
type: secondary

features:
- title: Simplicity First
details: Minimal setup with markdown-centered project structure helps you focus on writing.
- title: Vue-Powered
details: Enjoy the dev experience of Vue, use Vue components in markdown, and develop custom themes with Vue.
- title: Performant
details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
- title: Themes
details: Providing a default theme out of the box. You can also choose a community theme or create your own one.
- title: Plugins
details: Flexible plugin API, allowing plugins to provide lots of plug-and-play features for your site.
- title: Bundlers
details: Default bundler is Vite, while Webpack is also supported. Choose the one you like!

footer: MIT Licensed | Copyright © 2018-present VuePress Community

## Requirements

Before using this template, you need to:

- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

Fill in the fields presented on the configuration form and deploy the template. This will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project.

---

This is the content of home page. Check [Home Page Docs][default-theme-home] for more details.
## Deploy your own

Deploy your own VuePress Boilerplate project with Azion.

[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/vuepress/vuepress-boilerplate "Deploy with Azion")

[default-theme-home]: https://vuejs.press/reference/default-theme/frontmatter.html#home-page
For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vuepress-boilerplate/).
39 changes: 29 additions & 10 deletions templates/vuepress/vuepress-hope-blog/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,36 @@
# online-demo
# VuePress Blog with Hope Theme

[Fork on StackBlitz ⚡️](https://stackblitz.com/fork/vuepress-theme-hope)
The **VuePress Blog with Hope Theme** template is a [VuePress](https://vuepress.vuejs.org/guide/introduction.html) blog website starter kit powered by the popular [Hope theme](https://theme-hope.vuejs.press/).

## ⚠️⚠️⚠️This demo can not run on stackblitz now, because the Sass codes in Vite are using APIs that is not supported by stackblitz core.
The deployment creates an edge application with customizable configurations, an **Edge Storage** origin for content delivery, and a GitHub repository based on the template to facilitate your access and management through the Azion Edge Platform.

## To run the project, you should clone it and run in a local env!
This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy a web application based on VuePress using templates](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/) guide.

This template uses VuePress version `2.0.0`.

## Docs Demo
> **Note**: this is a community template. It was created by third-party or external developers and Azion is only enabling the deployment in the Azion Edge Platform. Azion doesn't provide maintenance or support for the content itself but can assist you with any queries or issues you may encounter while deploying this template or using the platform.
>
> Join the Azion communities at [GitHub](https://github.com/aziontech) and [Discord](https://discord.com/channels/1112754829878624390/1113104727979348008) to learn, seek advice, and stay updated on trends.

- Preview: `pnpm run docs:dev`
- Build: `pnpm run docs:build`
---

## Blog Demo
## Requirements

- Preview: `pnpm run blog:dev`
- Build: `pnpm run blog:build`
Before using this template, you need to:

- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

Fill in the fields presented on the configuration form and deploy the template. This will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project.

---

## Deploy your own

Deploy your own VuePress Blog with Hope Theme project with Azion.

[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/azion-community/vuepress-blog-with-hope-theme "Deploy with Azion")

For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/).
39 changes: 29 additions & 10 deletions templates/vuepress/vuepress-hope-docs/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,36 @@
# online-demo
# VuePress Docs with Hope Theme

[Fork on StackBlitz ⚡️](https://stackblitz.com/fork/vuepress-theme-hope)
The **VuePress Docs with Hope Theme** template is a [VuePress](https://vuepress.vuejs.org/guide/introduction.html) documentation website starter kit powered by the popular [Hope theme](https://theme-hope.vuejs.press/).

## ⚠️⚠️⚠️This demo can not run on stackblitz now, because the Sass codes in Vite are using APIs that is not supported by stackblitz core.
The deployment creates an edge application with customizable configurations, an **Edge Storage** origin for content delivery, and a GitHub repository based on the template to facilitate your access and management through the Azion Edge Platform.

## To run the project, you should clone it and run in a local env!
This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy a web application based on VuePress using templates](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/) guide.

This template uses VuePress version `2.0.0`.

## Docs Demo
> **Note**: this is a community template. It was created by third-party or external developers and Azion is only enabling the deployment in the Azion Edge Platform. Azion doesn't provide maintenance or support for the content itself but can assist you with any queries or issues you may encounter while deploying this template or using the platform.
>
> Join the Azion communities at [GitHub](https://github.com/aziontech) and [Discord](https://discord.com/channels/1112754829878624390/1113104727979348008) to learn, seek advice, and stay updated on trends.

- Preview: `pnpm run docs:dev`
- Build: `pnpm run docs:build`
---

## Blog Demo
## Requirements

- Preview: `pnpm run blog:dev`
- Build: `pnpm run blog:build`
Before using this template, you need to:

- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

Fill in the fields presented on the configuration form and deploy the template. This will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project.

---

## Deploy your own

Deploy your own VuePress Docs with Hope Theme project with Azion.

[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/azion-community/vuepress-docs-with-hope-theme "Deploy with Azion")

For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/).
67 changes: 20 additions & 47 deletions templates/vuepress/vuepress-live2d-plus/README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,36 @@
# vuepress-plugin-live2d-plus
# VuePress Live2D Plus

## 简介
The **VuePress Live2D Plus** template is a [VuePress](https://vuepress.vuejs.org/guide/introduction.html) documentation website starter kit that features an integrated [Live2D plugin](https://github.com/xinlei3166/vuepress-plugin-live2d-plus).

vuepress-plugin-live2d-plus 是一个基于 Vuepress 2.x 的插件,它可以帮助你集成Live2D看板娘。
The deployment creates an edge application with customizable configurations, an **Edge Storage** origin for content delivery, and a GitHub repository based on the template to facilitate your access and management through the Azion Edge Platform.

## 提示
已支持[email protected]版本
This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy a web application based on VuePress using templates](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/) guide.

## 安装
This template uses VuePress version `2.0.0`.

```bash
npm install -D vuepress-plugin-live2d-plus
yarn add -D vuepress-plugin-live2d-plus
```
> **Note**: this is a community template. It was created by third-party or external developers and Azion is only enabling the deployment in the Azion Edge Platform. Azion doesn't provide maintenance or support for the content itself but can assist you with any queries or issues you may encounter while deploying this template or using the platform.
>
> Join the Azion communities at [GitHub](https://github.com/aziontech) and [Discord](https://discord.com/channels/1112754829878624390/1113104727979348008) to learn, seek advice, and stay updated on trends.

---

## 用法
## Requirements

.vuepress/config.js文件中使用插件
Before using this template, you need to:

```js
import { live2dPlugin } from 'vuepress-plugin-live2d-plus'
- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

plugins: [
live2dPlugin()
]
```
> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

自定义参数
Fill in the fields presented on the configuration form and deploy the template. This will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project.

```js
plugins: [
live2dPlugin({
enable: true,
model: {
url: 'https://raw.githubusercontent.com/iCharlesZ/vscode-live2d-models/master/model-library/hibiki/hibiki.model.json'
},
display: {
position: 'right',
width: '135px',
height: '300px',
xOffset: '35px',
yOffset: '5px'
},
mobile: {
show: true
},
react: {
opacity: 0.8
}
})
]
```
---

## Deploy your own

## 模型
使用了 [vscode-live2d-models](https://github.com/iCharlesZ/vscode-live2d-models#url) 中的模型,把 `model.url` 改为指定的模型地址即可。
Deploy your own VuePress Live2D Plus project with Azion.

[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/azion-community/vuepress-live2d-plus "Deploy with Azion")

## 感谢
vuepress-plugin-live2d-plus 参考了 [vuepress-plugin-helper-live2d](https://github.com/JoeyBling/vuepress-plugin-helper-live2d)

For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/).
37 changes: 33 additions & 4 deletions templates/vuepress/vuepress-moefy/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
# Moefy VuePress
# VuePress Moefy

让你的 VuePress 变得更加可爱~
The **VuePress Moefy** template is a [VuePress](https://vuepress.vuejs.org/guide/introduction.html) starter kit including plugins and animation features.

> **Warning**
The deployment creates an edge application with customizable configurations, an **Edge Storage** origin for content delivery, and a GitHub repository based on the template to facilitate your access and management through the Azion Edge Platform.

This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy a web application based on VuePress using templates](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/) guide.

This template uses VuePress version `1.9.9`.

> **Note**: this is a community template. It was created by third-party or external developers and Azion is only enabling the deployment in the Azion Edge Platform. Azion doesn't provide maintenance or support for the content itself but can assist you with any queries or issues you may encounter while deploying this template or using the platform.
>
> 这些插件仅支持 [VuePress V1](https://github.com/vuejs/vuepress),不支持 [VuePress V2](https://github.com/vuepress/vuepress-next) 及 [VitePress](https://github.com/vuejs/vitepress)。如果你想在非 VuePress V1 环境下使用 ribbon 或 cursor-effects 插件,可以尝试 [moefy-canvas](https://github.com/moefyit/moefy-canvas)(事实上现在 ribbon 和 cursor-effects 插件只是 moefy-canvas 的一个简单包装)~
> Join the Azion communities at [GitHub](https://github.com/aziontech) and [Discord](https://discord.com/channels/1112754829878624390/1113104727979348008) to learn, seek advice, and stay updated on trends.

---

## Requirements

Before using this template, you need to:

- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

Fill in the fields presented on the configuration form and deploy the template. This will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project.

---

## Deploy your own

Deploy your own VuePress Moefy project with Azion.

[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/azion-community/vuepress-moefy "Deploy with Azion")

For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vuepress-templates-collection/).
Loading
Loading