Merge pull request #2029 from Nishantjain10/docs-sites-integration
docs: add integration guides for Appwrite Sites templates
@@ -101,6 +101,11 @@ export const integrationCategoryDescriptions: IntegrationCategory[] = [
|
||||
heading: 'Search',
|
||||
description: 'Implement search functionalities'
|
||||
},
|
||||
{
|
||||
slug: 'sites',
|
||||
heading: 'Sites',
|
||||
description: 'Deploy and host web applications'
|
||||
},
|
||||
{
|
||||
slug: 'storage',
|
||||
heading: 'Storage',
|
||||
|
||||
123
src/routes/integrations/sites-docusaurus/+page.markdoc
Normal file
@@ -0,0 +1,123 @@
|
||||
---
|
||||
layout: integration
|
||||
title: Deploy Docusaurus with Sites
|
||||
description: Build an MDX-powered documentation site with Appwrite Sites
|
||||
date: 2025-05-19
|
||||
featured: false
|
||||
isPartner: true
|
||||
isNew: true
|
||||
cover: /images/integrations/sites-docusaurus/cover.png
|
||||
category: sites
|
||||
product:
|
||||
avatar: '/images/integrations/avatars/docusaurus.png'
|
||||
vendor: Docusaurus
|
||||
description: 'Docusaurus is a modern static website generator optimized for building fast, accessible documentation websites with React.'
|
||||
platform:
|
||||
- 'Cloud'
|
||||
- 'Self-hosted'
|
||||
images:
|
||||
- /images/integrations/sites-docusaurus/cover.png
|
||||
- /images/integrations/sites-docusaurus/search-site.png
|
||||
- /images/integrations/sites-docusaurus/success.png
|
||||
- /images/integrations/sites-docusaurus/homepage.png
|
||||
- /images/integrations/sites-docusaurus/tutorial-page.png
|
||||
- /images/integrations/sites-docusaurus/blog-page.png
|
||||
---
|
||||
|
||||
Docusaurus is a modern static website generator that makes it easy to create and maintain documentation websites. Built with React and powered by Markdown, Docusaurus helps you focus on writing content while taking care of the technical details.
|
||||
|
||||
With Appwrite Sites, you can deploy your Docusaurus documentation in minutes using our pre-built template, with features like automatic builds, custom domains, and global CDN distribution.
|
||||
|
||||
# How does the integration work?
|
||||
|
||||
[Appwrite Sites](https://appwrite.io/products/sites) provides a ready-to-use Docusaurus template that you can deploy instantly. The template comes with a pre-configured setup optimized for documentation sites, making it easy to get started without any complex configuration.
|
||||
|
||||
|
||||
To deploy the Docusaurus template with Appwrite Sites, follow these steps:
|
||||
|
||||
## Create site
|
||||
|
||||
After signing into your Appwrite console, look at the sidebar on the left. Under the **Deploy** section, you will find the **Sites** button.
|
||||
|
||||
Clicking it opens the Sites page. Here, you will see the **Sites** tab selected by default. Click **Create site** to start the deployment process.
|
||||
|
||||

|
||||
|
||||
At this point, Appwrite offers two options: **Clone a template** or **Connect a repository**. For this guide, we will focus on cloning the Docusaurus template, which lets you quickly set up a documentation site based on a pre-built project.
|
||||
|
||||

|
||||
|
||||
## Finding the Docusaurus template
|
||||
|
||||
When you select **Clone a template**, you'll see a library of templates. To find the Docusaurus template:
|
||||
|
||||
1. Use the search bar at the top and type "Docusaurus"
|
||||
|
||||

|
||||
|
||||
|
||||
After selecting the template, you'll need to choose how to deploy it, Clicking the Docusaurus template will open a new page where you can configure your documentation site.
|
||||
|
||||
|
||||
|
||||
## Configuring your site
|
||||
|
||||
### Setting up site details
|
||||
|
||||
Once you have selected the Docusaurus template, you will be prompted to enter basic details for your site.
|
||||
|
||||
You will need to provide a **Site name** and a **Site ID**. The Site ID becomes part of your site's URL, so it should be lowercase and use hyphens if necessary.
|
||||
|
||||
|
||||

|
||||
At this stage, you can choose whether to connect your repository now or later.
|
||||
|
||||
|
||||
|
||||
If you choose **Connect your repository**, you will be able to either create a new repository based on the template or link it to an existing one. If you prefer to skip this step for now, you can choose **Connect later** and connect your version control later using the CLI or through the settings page.
|
||||
|
||||
If you opt to connect a repository immediately, you will see the following options:
|
||||
|
||||
- Select whether to create a new repository or connect to an existing one
|
||||
- (Optional) Choose a GitHub organization if you have access to multiple organizations
|
||||
- Name your repository if you are creating a new one
|
||||
- Decide whether to keep the repository private by ticking the checkbox
|
||||
|
||||
Additionally, you can define the domain for your site, using the Appwrite Sites domain.
|
||||
|
||||
After reviewing your configuration, click **Deploy**.
|
||||
|
||||
|
||||
## Monitoring the deployment
|
||||
|
||||
Once you initiate the deployment, you will be taken to a progress page where you can monitor the build and deployment in real time.
|
||||
|
||||
The logs will show you the different stages of the build process. Depending on the size of your template and the dependencies involved, this process can take anywhere from a few seconds to a few minutes.
|
||||
|
||||

|
||||
|
||||
## Access your site
|
||||
|
||||
After your site has been successfully deployed, Appwrite will show you a **Congratulations** page.
|
||||
|
||||

|
||||
|
||||
## Next step
|
||||
|
||||
Appwrite provides a few options to help you continue setting up or expanding your project.
|
||||
|
||||
You can **Add domain**, connecting an existing custom domain you own or registering a new one through the console.
|
||||
|
||||
You can **Share site**, allowing you to collaborate with your team by sharing access to your project.
|
||||
|
||||
You can also **Open on mobile**, previewing your live site directly from a mobile or tablet device to ensure everything looks and functions as expected across different screen sizes.
|
||||
|
||||
## Wrapping up
|
||||
And with that, the Docusaurus template is deployed to Appwrite Sites. You can explore other templates or deploy any other websites you'd like.
|
||||
|
||||
## More Resources
|
||||
|
||||
- [Appwrite Sites Docs](/docs/products/sites)
|
||||
- [Docusaurus Website](https://docusaurus.io/)
|
||||
- [Appwrite Sites video announcement](https://youtu.be/0cERQxFjTW4)
|
||||
- [Appwrite Discord server](/discord)
|
||||
123
src/routes/integrations/sites-magic-portfolio/+page.markdoc
Normal file
@@ -0,0 +1,123 @@
|
||||
---
|
||||
layout: integration
|
||||
title: Deploy Magic Portfolio with Sites
|
||||
description: Showcase your creative work with a customizable portfolio with Appwrite Sites
|
||||
date: 2025-05-19
|
||||
featured: false
|
||||
isPartner: true
|
||||
isNew: true
|
||||
cover: /images/integrations/sites-magic-portfolio/cover.png
|
||||
category: sites
|
||||
product:
|
||||
avatar: '/images/integrations/avatars/magic-portfolio.png'
|
||||
vendor: Magic Portfolio
|
||||
description: 'A portfolio template designed for creatives, indie hackers, and engineers to showcase their work with style, speed, and full control.'
|
||||
platform:
|
||||
- 'Cloud'
|
||||
- 'Self-hosted'
|
||||
images:
|
||||
- /images/integrations/sites-magic-portfolio/cover.png
|
||||
- /images/integrations/sites-magic-portfolio/homepage.png
|
||||
- /images/integrations/sites-magic-portfolio/about-page.png
|
||||
- /images/integrations/sites-magic-portfolio/work-page.png
|
||||
- /images/integrations/sites-magic-portfolio/site-details.png
|
||||
- /images/integrations/sites-magic-portfolio/success.png
|
||||
---
|
||||
|
||||
Magic Portfolio is a modern portfolio template that makes it easy to create and maintain your personal or professional portfolio website. Make your portfolio uniquely yours with customizable themes, brand colors, and fine-tuned visual details like borders and transitions.
|
||||
|
||||
With Appwrite Sites, you can deploy your portfolio in minutes using our pre-built template, with features like automatic builds, custom domains, and global CDN distribution.
|
||||
|
||||
# How does the integration work?
|
||||
|
||||
[Appwrite Sites](https://appwrite.io/products/sites) provides a ready-to-use Magic Portfolio template that you can deploy instantly. The template comes with a pre-configured setup optimized for portfolio sites, making it easy to get started without any complex configuration.
|
||||
|
||||
|
||||
To deploy the Magic Portfolio template with Appwrite Sites, follow these steps:
|
||||
|
||||
## Create site
|
||||
|
||||
After signing into your Appwrite console, look at the sidebar on the left. Under the **Deploy** section, you will find the **Sites** button.
|
||||
|
||||
Clicking it opens the Sites page. Here, you will see the **Sites** tab selected by default. Click **Create site** to start the deployment process.
|
||||
|
||||

|
||||
|
||||
At this point, Appwrite offers two options: **Clone a template** or **Connect a repository**. For this guide, we will focus on cloning the Magic Portfolio template, which lets you quickly set up a portfolio site based on a pre-built project.
|
||||
|
||||

|
||||
|
||||
## Finding the Magic Portfolio template
|
||||
|
||||
When you select **Clone a template**, you'll see a library of templates. To find the Magic Portfolio template:
|
||||
|
||||
1. Use the search bar at the top and type "Magic Portfolio"
|
||||
|
||||

|
||||
|
||||
|
||||
After selecting the template, you'll need to choose how to deploy it, Clicking the Magic Portfolio template will open a new page where you can configure your portfolio site.
|
||||
|
||||
|
||||
|
||||
## Configuring your site
|
||||
|
||||
### Setting up site details
|
||||
|
||||
Once you have selected the Magic Portfolio template, you will be prompted to enter basic details for your site.
|
||||
|
||||
You will need to provide a **Site name** and a **Site ID**. The Site ID becomes part of your site's URL, so it should be lowercase and use hyphens if necessary.
|
||||
|
||||
|
||||

|
||||
At this stage, you can choose whether to connect your repository now or later.
|
||||
|
||||
|
||||
|
||||
If you choose **Connect your repository**, you will be able to either create a new repository based on the template or link it to an existing one. If you prefer to skip this step for now, you can choose **Connect later** and connect your version control later using the CLI or through the settings page.
|
||||
|
||||
If you opt to connect a repository immediately, you will see the following options:
|
||||
|
||||
- Select whether to create a new repository or connect to an existing one
|
||||
- (Optional) Choose a GitHub organization if you have access to multiple organizations
|
||||
- Name your repository if you are creating a new one
|
||||
- Decide whether to keep the repository private by ticking the checkbox
|
||||
|
||||
Additionally, you can define the domain for your site, using the Appwrite Sites domain.
|
||||
|
||||
After reviewing your configuration, click **Deploy**.
|
||||
|
||||
|
||||
## Monitoring the deployment
|
||||
|
||||
Once you initiate the deployment, you will be taken to a progress page where you can monitor the build and deployment in real time.
|
||||
|
||||
The logs will show you the different stages of the build process. Depending on the size of your template and the dependencies involved, this process can take anywhere from a few seconds to a few minutes.
|
||||
|
||||

|
||||
|
||||
## Access your site
|
||||
|
||||
After your site has been successfully deployed, Appwrite will show you a **Congratulations** page.
|
||||
|
||||

|
||||
|
||||
## Next step
|
||||
|
||||
Appwrite provides a few options to help you continue setting up or expanding your project.
|
||||
|
||||
You can **Add domain**, connecting an existing custom domain you own or registering a new one through the console.
|
||||
|
||||
You can **Share site**, allowing you to collaborate with your team by sharing access to your project.
|
||||
|
||||
You can also **Open on mobile**, previewing your live site directly from a mobile or tablet device to ensure everything looks and functions as expected across different screen sizes.
|
||||
|
||||
## Wrapping up
|
||||
And with that, the Magic Portfolio template is deployed to Appwrite Sites. You can now connect your GitHub repository and customize your portfolio with themes, colors, and content. You can also explore other templates or deploy any other websites you'd like.
|
||||
|
||||
## More Resources
|
||||
|
||||
- [Appwrite Sites Docs](/docs/products/sites)
|
||||
- [Magic Portfolio Website](https://magic-portfolio.com)
|
||||
- [Appwrite Sites video announcement](https://youtu.be/0cERQxFjTW4)
|
||||
- [Appwrite Discord server](/discord)
|
||||
122
src/routes/integrations/sites-nxtlnk/+page.markdoc
Normal file
@@ -0,0 +1,122 @@
|
||||
---
|
||||
layout: integration
|
||||
title: Deploy Nxtlnk with Sites
|
||||
description: Build a custom bio links page with Appwrite Sites
|
||||
date: 2025-05-19
|
||||
featured: false
|
||||
isPartner: true
|
||||
isNew: true
|
||||
cover: /images/integrations/sites-nxtlnk/cover.png
|
||||
category: sites
|
||||
product:
|
||||
avatar: '/images/integrations/avatars/nxtlnk.png'
|
||||
vendor: Nxtlnk
|
||||
description: 'Custom bio links for creatives who love coding. A template to create your custom bio link and self-host on your own domain.'
|
||||
platform:
|
||||
- 'Cloud'
|
||||
- 'Self-hosted'
|
||||
images:
|
||||
- /images/integrations/sites-nxtlnk/cover.png
|
||||
- /images/integrations/sites-nxtlnk/homepage.png
|
||||
- /images/integrations/sites-nxtlnk/clone-template.png
|
||||
- /images/integrations/sites-nxtlnk/site-details.png
|
||||
- /images/integrations/sites-nxtlnk/success.png
|
||||
---
|
||||
|
||||
Nxtlnk is a modern bio links template that makes it easy to create and maintain your personal links page. Made for creatives who love coding, this template lets you create a custom bio link page and self-host it on your own domain.
|
||||
|
||||
With Appwrite Sites, you can deploy your bio links page in minutes using our pre-built template, with features like automatic builds, custom domains, and global CDN distribution.
|
||||
|
||||
# How does the integration work?
|
||||
|
||||
[Appwrite Sites](https://appwrite.io/products/sites) provides a ready-to-use Nxtlnk template that you can deploy instantly. The template comes with a pre-configured setup optimized for bio link sites, making it easy to get started without any complex configuration.
|
||||
|
||||
|
||||
To deploy the Nxtlnk template with Appwrite Sites, follow these steps:
|
||||
|
||||
## Create site
|
||||
|
||||
After signing into your Appwrite console, look at the sidebar on the left. Under the **Deploy** section, you will find the **Sites** button.
|
||||
|
||||
Clicking it opens the Sites page. Here, you will see the **Sites** tab selected by default. Click **Create site** to start the deployment process.
|
||||
|
||||

|
||||
|
||||
At this point, Appwrite offers two options: **Clone a template** or **Connect a repository**. For this guide, we will focus on cloning the Nxtlnk template, which lets you quickly set up a bio links site based on a pre-built project.
|
||||
|
||||

|
||||
|
||||
## Finding the Nxtlnk template
|
||||
|
||||
When you select **Clone a template**, you'll see a library of templates. To find the Nxtlnk template:
|
||||
|
||||
1. Use the search bar at the top and type "Nxtlnk"
|
||||
|
||||

|
||||
|
||||
|
||||
After selecting the template, you'll need to choose how to deploy it, Clicking the Nxtlnk template will open a new page where you can configure your bio links site.
|
||||
|
||||
|
||||
|
||||
## Configuring your site
|
||||
|
||||
### Setting up site details
|
||||
|
||||
Once you have selected the Nxtlnk template, you will be prompted to enter basic details for your site.
|
||||
|
||||
You will need to provide a **Site name** and a **Site ID**. The Site ID becomes part of your site's URL, so it should be lowercase and use hyphens if necessary.
|
||||
|
||||
|
||||

|
||||
At this stage, you can choose whether to connect your repository now or later.
|
||||
|
||||
|
||||
|
||||
If you choose **Connect your repository**, you will be able to either create a new repository based on the template or link it to an existing one. If you prefer to skip this step for now, you can choose **Connect later** and connect your version control later using the CLI or through the settings page.
|
||||
|
||||
If you opt to connect a repository immediately, you will see the following options:
|
||||
|
||||
- Select whether to create a new repository or connect to an existing one
|
||||
- (Optional) Choose a GitHub organization if you have access to multiple organizations
|
||||
- Name your repository if you are creating a new one
|
||||
- Decide whether to keep the repository private by ticking the checkbox
|
||||
|
||||
Additionally, you can define the domain for your site, using the Appwrite Sites domain.
|
||||
|
||||
After reviewing your configuration, click **Deploy**.
|
||||
|
||||
|
||||
## Monitoring the deployment
|
||||
|
||||
Once you initiate the deployment, you will be taken to a progress page where you can monitor the build and deployment in real time.
|
||||
|
||||
The logs will show you the different stages of the build process. Depending on the size of your template and the dependencies involved, this process can take anywhere from a few seconds to a few minutes.
|
||||
|
||||

|
||||
|
||||
## Access your site
|
||||
|
||||
After your site has been successfully deployed, Appwrite will show you a **Congratulations** page.
|
||||
|
||||

|
||||
|
||||
## Next step
|
||||
|
||||
Appwrite provides a few options to help you continue setting up or expanding your project.
|
||||
|
||||
You can **Add domain**, connecting an existing custom domain you own or registering a new one through the console.
|
||||
|
||||
You can **Share site**, allowing you to collaborate with your team by sharing access to your project.
|
||||
|
||||
You can also **Open on mobile**, previewing your live site directly from a mobile or tablet device to ensure everything looks and functions as expected across different screen sizes.
|
||||
|
||||
## Wrapping up
|
||||
And with that, the Nxtlnk template is deployed to Appwrite Sites. You can now connect your GitHub repository and customize your bio links page with your own content and styling. You can also explore other templates or deploy any other websites you'd like.
|
||||
|
||||
## More Resources
|
||||
|
||||
- [Appwrite Sites Docs](/docs/products/sites)
|
||||
- [Nxtlnk Website](https://nxtlnk.xyz)
|
||||
- [Appwrite Sites video announcement](https://youtu.be/0cERQxFjTW4)
|
||||
- [Appwrite Discord server](/discord)
|
||||
123
src/routes/integrations/sites-starlight/+page.markdoc
Normal file
@@ -0,0 +1,123 @@
|
||||
---
|
||||
layout: integration
|
||||
title: Deploy Starlight with Sites
|
||||
description: Create a Astro-based documentation site with Appwrite Sites
|
||||
date: 2025-05-19
|
||||
featured: false
|
||||
isPartner: true
|
||||
isNew: true
|
||||
cover: /images/integrations/sites-starlight/cover.png
|
||||
category: sites
|
||||
product:
|
||||
avatar: '/images/integrations/avatars/starlight.png'
|
||||
vendor: Starlight
|
||||
description: 'Starlight is a documentation website framework built with Astro that helps you build beautiful, high-performance documentation sites with minimal setup.'
|
||||
platform:
|
||||
- 'Cloud'
|
||||
- 'Self-hosted'
|
||||
images:
|
||||
- /images/integrations/sites-starlight/cover.png
|
||||
- /images/integrations/sites-starlight/homepage.png
|
||||
- /images/integrations/sites-starlight/search-site.png
|
||||
- /images/integrations/sites-starlight/clone-template.png
|
||||
- /images/integrations/sites-starlight/site-details.png
|
||||
- /images/integrations/sites-starlight/success.png
|
||||
---
|
||||
|
||||
Starlight is a modern documentation framework built on top of Astro that makes it easy to create beautiful, high-performance documentation websites. Built with Astro and powered by Markdown, Starlight helps you focus on writing content while taking care of the technical details.
|
||||
|
||||
With Appwrite Sites, you can deploy your Starlight documentation in minutes using our pre-built template, with features like automatic builds, custom domains, and global CDN distribution.
|
||||
|
||||
# How does the integration work?
|
||||
|
||||
[Appwrite Sites](https://appwrite.io/products/sites) provides a ready-to-use Starlight template that you can deploy instantly. The template comes with a pre-configured setup optimized for documentation sites, making it easy to get started without any complex configuration.
|
||||
|
||||
|
||||
To deploy the Starlight template with Appwrite Sites, follow these steps:
|
||||
|
||||
## Create site
|
||||
|
||||
After signing into your Appwrite console, look at the sidebar on the left. Under the **Deploy** section, you will find the **Sites** button.
|
||||
|
||||
Clicking it opens the Sites page. Here, you will see the **Sites** tab selected by default. Click **Create site** to start the deployment process.
|
||||
|
||||

|
||||
|
||||
At this point, Appwrite offers two options: **Clone a template** or **Connect a repository**. For this guide, we will focus on cloning the Starlight template, which lets you quickly set up a documentation site based on a pre-built project.
|
||||
|
||||

|
||||
|
||||
## Finding the Starlight template
|
||||
|
||||
When you select **Clone a template**, you'll see a library of templates. To find the Starlight template:
|
||||
|
||||
1. Use the search bar at the top and type "Starlight"
|
||||
|
||||

|
||||
|
||||
|
||||
After selecting the template, you'll need to choose how to deploy it, Clicking the Starlight template will open a new page where you can configure your documentation site.
|
||||
|
||||
|
||||
|
||||
## Configuring your site
|
||||
|
||||
### Setting up site details
|
||||
|
||||
Once you have selected the Starlight template, you will be prompted to enter basic details for your site.
|
||||
|
||||
You will need to provide a **Site name** and a **Site ID**. The Site ID becomes part of your site's URL, so it should be lowercase and use hyphens if necessary.
|
||||
|
||||
|
||||

|
||||
At this stage, you can choose whether to connect your repository now or later.
|
||||
|
||||
|
||||
|
||||
If you choose **Connect your repository**, you will be able to either create a new repository based on the template or link it to an existing one. If you prefer to skip this step for now, you can choose **Connect later** and connect your version control later using the CLI or through the settings page.
|
||||
|
||||
If you opt to connect a repository immediately, you will see the following options:
|
||||
|
||||
- Select whether to create a new repository or connect to an existing one
|
||||
- (Optional) Choose a GitHub organization if you have access to multiple organizations
|
||||
- Name your repository if you are creating a new one
|
||||
- Decide whether to keep the repository private by ticking the checkbox
|
||||
|
||||
Additionally, you can define the domain for your site, using the Appwrite Sites domain.
|
||||
|
||||
After reviewing your configuration, click **Deploy**.
|
||||
|
||||
|
||||
## Monitoring the deployment
|
||||
|
||||
Once you initiate the deployment, you will be taken to a progress page where you can monitor the build and deployment in real time.
|
||||
|
||||
The logs will show you the different stages of the build process. Depending on the size of your template and the dependencies involved, this process can take anywhere from a few seconds to a few minutes.
|
||||
|
||||

|
||||
|
||||
## Access your site
|
||||
|
||||
After your site has been successfully deployed, Appwrite will show you a **Congratulations** page.
|
||||
|
||||

|
||||
|
||||
## Next step
|
||||
|
||||
Appwrite provides a few options to help you continue setting up or expanding your project.
|
||||
|
||||
You can **Add domain**, connecting an existing custom domain you own or registering a new one through the console.
|
||||
|
||||
You can **Share site**, allowing you to collaborate with your team by sharing access to your project.
|
||||
|
||||
You can also **Open on mobile**, previewing your live site directly from a mobile or tablet device to ensure everything looks and functions as expected across different screen sizes.
|
||||
|
||||
## Wrapping up
|
||||
And with that, the Starlight template is deployed to Appwrite Sites. You can explore other templates or deploy any other websites you'd like.
|
||||
|
||||
## More Resources
|
||||
|
||||
- [Appwrite Sites Docs](/docs/products/sites)
|
||||
- [Starlight Website](https://starlight.astro.build/)
|
||||
- [Appwrite Sites video announcement](https://youtu.be/0cERQxFjTW4)
|
||||
- [Appwrite Discord server](/discord)
|
||||
122
src/routes/integrations/sites-vuepress/+page.markdoc
Normal file
@@ -0,0 +1,122 @@
|
||||
---
|
||||
layout: integration
|
||||
title: Deploy VuePress with Sites
|
||||
description: Create a Vue-based documentation site with Appwrite Sites
|
||||
date: 2025-05-19
|
||||
featured: false
|
||||
isPartner: true
|
||||
isNew: true
|
||||
cover: /images/integrations/sites-vuepress/cover.png
|
||||
category: sites
|
||||
product:
|
||||
avatar: '/images/integrations/avatars/vuepress.png'
|
||||
vendor: VuePress
|
||||
description: 'VuePress is a Vue-powered static site generator optimized for building fast, SEO-friendly documentation websites with Vue.js.'
|
||||
platform:
|
||||
- 'Cloud'
|
||||
- 'Self-hosted'
|
||||
images:
|
||||
- /images/integrations/sites-vuepress/cover.png
|
||||
- /images/integrations/sites-vuepress/homepage.png
|
||||
- /images/integrations/sites-vuepress/introduction-page.png
|
||||
- /images/integrations/sites-vuepress/site-details.png
|
||||
- /images/integrations/sites-vuepress/success.png
|
||||
---
|
||||
|
||||
VuePress is a modern static site generator that makes it easy to create and maintain documentation websites. Built with Vue.js and powered by Markdown, VuePress helps you focus on writing content while taking care of the technical details.
|
||||
|
||||
With Appwrite Sites, you can deploy your VuePress documentation in minutes using our pre-built template, with features like automatic builds, custom domains, and global CDN distribution.
|
||||
|
||||
# How does the integration work?
|
||||
|
||||
[Appwrite Sites](https://appwrite.io/products/sites) provides a ready-to-use VuePress template that you can deploy instantly. The template comes with a pre-configured setup optimized for documentation sites, making it easy to get started without any complex configuration.
|
||||
|
||||
|
||||
To deploy the VuePress template with Appwrite Sites, follow these steps:
|
||||
|
||||
## Create site
|
||||
|
||||
After signing into your Appwrite console, look at the sidebar on the left. Under the **Deploy** section, you will find the **Sites** button.
|
||||
|
||||
Clicking it opens the Sites page. Here, you will see the **Sites** tab selected by default. Click **Create site** to start the deployment process.
|
||||
|
||||

|
||||
|
||||
At this point, Appwrite offers two options: **Clone a template** or **Connect a repository**. For this guide, we will focus on cloning the VuePress template, which lets you quickly set up a documentation site based on a pre-built project.
|
||||
|
||||

|
||||
|
||||
## Finding the VuePress template
|
||||
|
||||
When you select **Clone a template**, you'll see a library of templates. To find the VuePress template:
|
||||
|
||||
1. Use the search bar at the top and type "VuePress"
|
||||
|
||||

|
||||
|
||||
|
||||
After selecting the template, you'll need to choose how to deploy it, Clicking the VuePress template will open a new page where you can configure your documentation site.
|
||||
|
||||
|
||||
|
||||
## Configuring your site
|
||||
|
||||
### Setting up site details
|
||||
|
||||
Once you have selected the VuePress template, you will be prompted to enter basic details for your site.
|
||||
|
||||
You will need to provide a **Site name** and a **Site ID**. The Site ID becomes part of your site's URL, so it should be lowercase and use hyphens if necessary.
|
||||
|
||||
|
||||

|
||||
At this stage, you can choose whether to connect your repository now or later.
|
||||
|
||||
|
||||
|
||||
If you choose **Connect your repository**, you will be able to either create a new repository based on the template or link it to an existing one. If you prefer to skip this step for now, you can choose **Connect later** and connect your version control later using the CLI or through the settings page.
|
||||
|
||||
If you opt to connect a repository immediately, you will see the following options:
|
||||
|
||||
- Select whether to create a new repository or connect to an existing one
|
||||
- (Optional) Choose a GitHub organization if you have access to multiple organizations
|
||||
- Name your repository if you are creating a new one
|
||||
- Decide whether to keep the repository private by ticking the checkbox
|
||||
|
||||
Additionally, you can define the domain for your site, using the Appwrite Sites domain.
|
||||
|
||||
After reviewing your configuration, click **Deploy**.
|
||||
|
||||
|
||||
## Monitoring the deployment
|
||||
|
||||
Once you initiate the deployment, you will be taken to a progress page where you can monitor the build and deployment in real time.
|
||||
|
||||
The logs will show you the different stages of the build process. Depending on the size of your template and the dependencies involved, this process can take anywhere from a few seconds to a few minutes.
|
||||
|
||||

|
||||
|
||||
## Access your site
|
||||
|
||||
After your site has been successfully deployed, Appwrite will show you a **Congratulations** page.
|
||||
|
||||

|
||||
|
||||
## Next step
|
||||
|
||||
Appwrite provides a few options to help you continue setting up or expanding your project.
|
||||
|
||||
You can **Add domain**, connecting an existing custom domain you own or registering a new one through the console.
|
||||
|
||||
You can **Share site**, allowing you to collaborate with your team by sharing access to your project.
|
||||
|
||||
You can also **Open on mobile**, previewing your live site directly from a mobile or tablet device to ensure everything looks and functions as expected across different screen sizes.
|
||||
|
||||
## Wrapping up
|
||||
And with that, the VuePress template is deployed to Appwrite Sites. You can explore other templates or deploy any other websites you'd like.
|
||||
|
||||
## More Resources
|
||||
|
||||
- [Appwrite Sites Docs](/docs/products/sites)
|
||||
- [VuePress Website](https://vuepress.vuejs.org/)
|
||||
- [Appwrite Sites video announcement](https://youtu.be/0cERQxFjTW4)
|
||||
- [Appwrite Discord server](/discord)
|
||||
BIN
static/images/integrations/avatars/docusaurus.png
Normal file
|
After Width: | Height: | Size: 26 KiB |
BIN
static/images/integrations/avatars/magic-portfolio.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
static/images/integrations/avatars/nxtlnk.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
BIN
static/images/integrations/avatars/starlight.png
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
static/images/integrations/avatars/vuepress.png
Normal file
|
After Width: | Height: | Size: 62 KiB |
BIN
static/images/integrations/sites-docusaurus/blog-page.png
Normal file
|
After Width: | Height: | Size: 140 KiB |
BIN
static/images/integrations/sites-docusaurus/clone-template.png
Normal file
|
After Width: | Height: | Size: 94 KiB |
BIN
static/images/integrations/sites-docusaurus/cover.png
Normal file
|
After Width: | Height: | Size: 1.7 MiB |
BIN
static/images/integrations/sites-docusaurus/create-site.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
|
After Width: | Height: | Size: 145 KiB |
BIN
static/images/integrations/sites-docusaurus/homepage.png
Normal file
|
After Width: | Height: | Size: 160 KiB |
BIN
static/images/integrations/sites-docusaurus/search-site.png
Normal file
|
After Width: | Height: | Size: 128 KiB |
BIN
static/images/integrations/sites-docusaurus/site-details.png
Normal file
|
After Width: | Height: | Size: 75 KiB |
BIN
static/images/integrations/sites-docusaurus/success.png
Normal file
|
After Width: | Height: | Size: 141 KiB |
BIN
static/images/integrations/sites-docusaurus/tutorial-page.png
Normal file
|
After Width: | Height: | Size: 151 KiB |
BIN
static/images/integrations/sites-magic-portfolio/about-page.png
Normal file
|
After Width: | Height: | Size: 437 KiB |
|
After Width: | Height: | Size: 94 KiB |
BIN
static/images/integrations/sites-magic-portfolio/cover.png
Normal file
|
After Width: | Height: | Size: 1.7 MiB |
BIN
static/images/integrations/sites-magic-portfolio/create-site.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
|
After Width: | Height: | Size: 106 KiB |
BIN
static/images/integrations/sites-magic-portfolio/homepage.png
Normal file
|
After Width: | Height: | Size: 631 KiB |
BIN
static/images/integrations/sites-magic-portfolio/search-site.png
Normal file
|
After Width: | Height: | Size: 174 KiB |
|
After Width: | Height: | Size: 88 KiB |
BIN
static/images/integrations/sites-magic-portfolio/success.png
Normal file
|
After Width: | Height: | Size: 161 KiB |
BIN
static/images/integrations/sites-magic-portfolio/work-page.png
Normal file
|
After Width: | Height: | Size: 534 KiB |
BIN
static/images/integrations/sites-nxtlnk/clone-template.png
Normal file
|
After Width: | Height: | Size: 94 KiB |
BIN
static/images/integrations/sites-nxtlnk/cover.png
Normal file
|
After Width: | Height: | Size: 1.7 MiB |
BIN
static/images/integrations/sites-nxtlnk/create-site.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
BIN
static/images/integrations/sites-nxtlnk/deployment-screen.png
Normal file
|
After Width: | Height: | Size: 98 KiB |
BIN
static/images/integrations/sites-nxtlnk/homepage.png
Normal file
|
After Width: | Height: | Size: 672 KiB |
BIN
static/images/integrations/sites-nxtlnk/search-site.png
Normal file
|
After Width: | Height: | Size: 174 KiB |
BIN
static/images/integrations/sites-nxtlnk/site-details.png
Normal file
|
After Width: | Height: | Size: 98 KiB |
BIN
static/images/integrations/sites-nxtlnk/success.png
Normal file
|
After Width: | Height: | Size: 183 KiB |
BIN
static/images/integrations/sites-starlight/clone-template.png
Normal file
|
After Width: | Height: | Size: 94 KiB |
BIN
static/images/integrations/sites-starlight/cover.png
Normal file
|
After Width: | Height: | Size: 1.7 MiB |
BIN
static/images/integrations/sites-starlight/create-site.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
BIN
static/images/integrations/sites-starlight/deployment-screen.png
Normal file
|
After Width: | Height: | Size: 95 KiB |
BIN
static/images/integrations/sites-starlight/homepage.png
Normal file
|
After Width: | Height: | Size: 130 KiB |
BIN
static/images/integrations/sites-starlight/search-site.png
Normal file
|
After Width: | Height: | Size: 174 KiB |
BIN
static/images/integrations/sites-starlight/site-details.png
Normal file
|
After Width: | Height: | Size: 81 KiB |
BIN
static/images/integrations/sites-starlight/success.png
Normal file
|
After Width: | Height: | Size: 152 KiB |
BIN
static/images/integrations/sites-vuepress/clone-template.png
Normal file
|
After Width: | Height: | Size: 94 KiB |
BIN
static/images/integrations/sites-vuepress/cover.png
Normal file
|
After Width: | Height: | Size: 1.7 MiB |
BIN
static/images/integrations/sites-vuepress/create-site.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
BIN
static/images/integrations/sites-vuepress/deployment-screen.png
Normal file
|
After Width: | Height: | Size: 184 KiB |
BIN
static/images/integrations/sites-vuepress/homepage.png
Normal file
|
After Width: | Height: | Size: 74 KiB |
BIN
static/images/integrations/sites-vuepress/introduction-page.png
Normal file
|
After Width: | Height: | Size: 86 KiB |
BIN
static/images/integrations/sites-vuepress/search-site.png
Normal file
|
After Width: | Height: | Size: 128 KiB |
BIN
static/images/integrations/sites-vuepress/site-details.png
Normal file
|
After Width: | Height: | Size: 74 KiB |
BIN
static/images/integrations/sites-vuepress/success.png
Normal file
|
After Width: | Height: | Size: 140 KiB |