Просмотр исходного кода

Remove .md extension from VitePress links (#4048)

* Remove .md extension from Vitepress links

* Fix exclude typo
Alec Rust 2 лет назад
Родитель
Сommit
ab91f96809

+ 43 - 43
docs/.vitepress/config.js

@@ -53,13 +53,13 @@ export default defineConfig({
 /** @returns {import("vitepress").DefaultTheme.NavItem[]} */
 function nav() {
 	return [
-		{ text: 'Features', link: '/features.md' },
-		{ text: 'Install', link: '/install.md' },
-		{ text: 'Documentation', link: '/docs/introduction/getting-started.md', activeMatch: '/docs/' },
-		{ text: 'Team', link: '/team.md' },
+		{ text: 'Features', link: '/features' },
+		{ text: 'Install', link: '/install' },
+		{ text: 'Documentation', link: '/docs/introduction/getting-started', activeMatch: '/docs/' },
+		{ text: 'Team', link: '/team' },
 		{ text: 'Demo', link: 'https://demo.hestiacp.com:8083/' },
 		{ text: 'Forum', link: 'https://forum.hestiacp.com/' },
-		{ text: 'Donate', link: '/donate.md' },
+		{ text: 'Donate', link: '/donate' },
 		{
 			text: `v${version}`,
 			items: [
@@ -86,77 +86,77 @@ function sidebarDocs() {
 			text: 'Introduction',
 			collapsed: false,
 			items: [
-				{ text: 'Getting started', link: '/docs/introduction/getting-started.md' },
-				{ text: 'Best practices', link: '/docs/introduction/best-practices.md' },
+				{ text: 'Getting started', link: '/docs/introduction/getting-started' },
+				{ text: 'Best practices', link: '/docs/introduction/best-practices' },
 			],
 		},
 		{
 			text: 'User guide',
 			collapsed: false,
 			items: [
-				{ text: 'Account', link: '/docs/user-guide/account.md' },
-				{ text: 'Backups', link: '/docs/user-guide/backups.md' },
-				{ text: 'Cron jobs', link: '/docs/user-guide/cron-jobs.md' },
-				{ text: 'Databases', link: '/docs/user-guide/databases.md' },
-				{ text: 'DNS', link: '/docs/user-guide/dns.md' },
-				{ text: 'File manager', link: '/docs/user-guide/file-manager.md' },
-				{ text: 'Mail domains', link: '/docs/user-guide/mail-domains.md' },
-				{ text: 'Notifications', link: '/docs/user-guide/notifications.md' },
-				{ text: 'Packages', link: '/docs/user-guide/packages.md' },
-				{ text: 'Statistics', link: '/docs/user-guide/statistics.md' },
-				{ text: 'Users', link: '/docs/user-guide/users.md' },
-				{ text: 'Web domains', link: '/docs/user-guide/web-domains.md' },
+				{ text: 'Account', link: '/docs/user-guide/account' },
+				{ text: 'Backups', link: '/docs/user-guide/backups' },
+				{ text: 'Cron jobs', link: '/docs/user-guide/cron-jobs' },
+				{ text: 'Databases', link: '/docs/user-guide/databases' },
+				{ text: 'DNS', link: '/docs/user-guide/dns' },
+				{ text: 'File manager', link: '/docs/user-guide/file-manager' },
+				{ text: 'Mail domains', link: '/docs/user-guide/mail-domains' },
+				{ text: 'Notifications', link: '/docs/user-guide/notifications' },
+				{ text: 'Packages', link: '/docs/user-guide/packages' },
+				{ text: 'Statistics', link: '/docs/user-guide/statistics' },
+				{ text: 'Users', link: '/docs/user-guide/users' },
+				{ text: 'Web domains', link: '/docs/user-guide/web-domains' },
 			],
 		},
 		{
 			text: 'Server administration',
 			collapsed: false,
 			items: [
-				{ text: 'Backup & restore', link: '/docs/server-administration/backup-restore.md' },
-				{ text: 'Configuration', link: '/docs/server-administration/configuration.md' },
-				{ text: 'Customisation', link: '/docs/server-administration/customisation.md' },
-				{ text: 'Databases & phpMyAdmin', link: '/docs/server-administration/databases.md' },
-				{ text: 'DNS clusters & DNSSEC', link: '/docs/server-administration/dns.md' },
-				{ text: 'Email', link: '/docs/server-administration/email.md' },
-				{ text: 'File manager', link: '/docs/server-administration/file-manager.md' },
-				{ text: 'Firewall', link: '/docs/server-administration/firewall.md' },
-				{ text: 'OS upgrades', link: '/docs/server-administration/os-upgrades.md' },
-				{ text: 'Rest API', link: '/docs/server-administration/rest-api.md' },
-				{ text: 'SSL certificates', link: '/docs/server-administration/ssl-certificates.md' },
-				{ text: 'Web templates & caching', link: '/docs/server-administration/web-templates.md' },
-				{ text: 'Troubleshooting', link: '/docs/server-administration/troubleshooting.md' },
+				{ text: 'Backup & restore', link: '/docs/server-administration/backup-restore' },
+				{ text: 'Configuration', link: '/docs/server-administration/configuration' },
+				{ text: 'Customisation', link: '/docs/server-administration/customisation' },
+				{ text: 'Databases & phpMyAdmin', link: '/docs/server-administration/databases' },
+				{ text: 'DNS clusters & DNSSEC', link: '/docs/server-administration/dns' },
+				{ text: 'Email', link: '/docs/server-administration/email' },
+				{ text: 'File manager', link: '/docs/server-administration/file-manager' },
+				{ text: 'Firewall', link: '/docs/server-administration/firewall' },
+				{ text: 'OS upgrades', link: '/docs/server-administration/os-upgrades' },
+				{ text: 'Rest API', link: '/docs/server-administration/rest-api' },
+				{ text: 'SSL certificates', link: '/docs/server-administration/ssl-certificates' },
+				{ text: 'Web templates & caching', link: '/docs/server-administration/web-templates' },
+				{ text: 'Troubleshooting', link: '/docs/server-administration/troubleshooting' },
 			],
 		},
 		{
 			text: 'Contributing',
 			collapsed: false,
 			items: [
-				{ text: 'Building Packages', link: '/docs/contributing/building.md' },
-				{ text: 'Development', link: '/docs/contributing/development.md' },
-				{ text: 'Documentation', link: '/docs/contributing/documentation.md' },
-				{ text: 'Quick install app', link: '/docs/contributing/quick-install-app.md' },
-				{ text: 'Testing', link: '/docs/contributing/testing.md' },
-				{ text: 'Translations', link: '/docs/contributing/translations.md' },
+				{ text: 'Building Packages', link: '/docs/contributing/building' },
+				{ text: 'Development', link: '/docs/contributing/development' },
+				{ text: 'Documentation', link: '/docs/contributing/documentation' },
+				{ text: 'Quick install app', link: '/docs/contributing/quick-install-app' },
+				{ text: 'Testing', link: '/docs/contributing/testing' },
+				{ text: 'Translations', link: '/docs/contributing/translations' },
 			],
 		},
 		{
 			text: 'Community',
 			collapsed: false,
 			items: [
-				{ text: 'Hestia Nginx Cache', link: '/docs/community/hestia-nginx-cache.md' },
+				{ text: 'Hestia Nginx Cache', link: '/docs/community/hestia-nginx-cache' },
 				{
 					text: 'Ioncube installer for Hestia',
-					link: '/docs/community/ioncube-hestia-installer.md',
+					link: '/docs/community/ioncube-hestia-installer',
 				},
-				{ text: 'Install script generator', link: '/docs/community/install-script-generator.md' },
+				{ text: 'Install script generator', link: '/docs/community/install-script-generator' },
 			],
 		},
 		{
 			text: 'Reference',
 			collapsed: false,
 			items: [
-				{ text: 'API', link: '/docs/reference/api.md' },
-				{ text: 'CLI', link: '/docs/reference/cli.md' },
+				{ text: 'API', link: '/docs/reference/api' },
+				{ text: 'CLI', link: '/docs/reference/cli' },
 			],
 		},
 	];

+ 38 - 38
docs/docs/index.md

@@ -2,56 +2,56 @@
 
 ## Getting started
 
-- [Getting started](/docs/introduction/getting-started.md)
-- [Best practices](/docs/introduction/best-practices.md)
+- [Getting started](/docs/introduction/getting-started)
+- [Best practices](/docs/introduction/best-practices)
 
 ## User Guide
 
-- [Account](/docs/user-guide/account.md)
-- [Backups](/docs/user-guide/backups.md)
-- [Cron jobs](/docs/user-guide/cron-jobs.md)
-- [Databases](/docs/user-guide/databases.md)
-- [DNS](/docs/user-guide/dns.md)
-- [File manager](/docs/user-guide/file-manager.md)
-- [Mail domains](/docs/user-guide/mail-domains.md)
-- [Notifications](/docs/user-guide/notifications.md)
-- [Packages](/docs/user-guide/packages.md)
-- [Statistics](/docs/user-guide/statistics.md)
-- [Users](/docs/user-guide/users.md)
-- [Web domains](/docs/user-guide/web-domains.md)
+- [Account](/docs/user-guide/account)
+- [Backups](/docs/user-guide/backups)
+- [Cron jobs](/docs/user-guide/cron-jobs)
+- [Databases](/docs/user-guide/databases)
+- [DNS](/docs/user-guide/dns)
+- [File manager](/docs/user-guide/file-manager)
+- [Mail domains](/docs/user-guide/mail-domains)
+- [Notifications](/docs/user-guide/notifications)
+- [Packages](/docs/user-guide/packages)
+- [Statistics](/docs/user-guide/statistics)
+- [Users](/docs/user-guide/users)
+- [Web domains](/docs/user-guide/web-domains)
 
 ## Server administration
 
-- [Backup & restore](/docs/server-administration/backup-restore.md)
-- [Configuration](/docs/server-administration/configuration.md)
-- [Customisation](/docs/server-administration/customisation.md)
-- [Databases & phpMyAdmin](/docs/server-administration/databases.md)
-- [DNS clusters & DNSSEC](/docs/server-administration/dns.md)
-- [Email](/docs/server-administration/email.md)
-- [File manager](/docs/server-administration/file-manager.md)
-- [Firewall](/docs/server-administration/firewall.md)
-- [OS upgrades](/docs/server-administration/os-upgrades.md)
-- [Rest API](/docs/server-administration/rest-api.md)
-- [SSL certificates](/docs/server-administration/ssl-certificates.md)
-- [Web templates & caching](/docs/server-administration/web-templates.md)
-- [Troubleshooting](/docs/server-administration/troubleshooting.md)
+- [Backup & restore](/docs/server-administration/backup-restore)
+- [Configuration](/docs/server-administration/configuration)
+- [Customisation](/docs/server-administration/customisation)
+- [Databases & phpMyAdmin](/docs/server-administration/databases)
+- [DNS clusters & DNSSEC](/docs/server-administration/dns)
+- [Email](/docs/server-administration/email)
+- [File manager](/docs/server-administration/file-manager)
+- [Firewall](/docs/server-administration/firewall)
+- [OS upgrades](/docs/server-administration/os-upgrades)
+- [Rest API](/docs/server-administration/rest-api)
+- [SSL certificates](/docs/server-administration/ssl-certificates)
+- [Web templates & caching](/docs/server-administration/web-templates)
+- [Troubleshooting](/docs/server-administration/troubleshooting)
 
 ## Contributing
 
-- [Building Packages](/docs/contributing/building.md)
-- [Development](/docs/contributing/development.md)
-- [Documentation](/docs/contributing/documentation.md)
-- [Quick install app](/docs/contributing/quick-install-app.md)
-- [Testing](/docs/contributing/testing.md)
-- [Translations](/docs/contributing/translations.md)
+- [Building Packages](/docs/contributing/building)
+- [Development](/docs/contributing/development)
+- [Documentation](/docs/contributing/documentation)
+- [Quick install app](/docs/contributing/quick-install-app)
+- [Testing](/docs/contributing/testing)
+- [Translations](/docs/contributing/translations)
 
 ## Community
 
-- [Hestia Nginx Cache](/docs/community/hestia-nginx-cache.md)
-- [Ioncube installer for Hestia](/docs/community/ioncube-hestia-installer.md)
-- [Install script generator](/docs/community/install-script-generator.md)
+- [Hestia Nginx Cache](/docs/community/hestia-nginx-cache)
+- [Ioncube installer for Hestia](/docs/community/ioncube-hestia-installer)
+- [Install script generator](/docs/community/install-script-generator)
 
 ## Reference
 
-- [API](/docs/reference/api.md)
-- [CLI](/docs/reference/cli.md)
+- [API](/docs/reference/api)
+- [CLI](/docs/reference/cli)

+ 2 - 2
docs/docs/introduction/best-practices.md

@@ -8,8 +8,8 @@ Managing a server is not easy. Here are some best practices you should try to ad
 By default, the **admin** user has elevated privileges. This can pose a **security threat** to your server. For example, if you run WordPress under your **admin** user and a vulnerability is found in WordPress or a plugin, a malicious user might be able to run commands as **root**!
 :::
 
-Before adding any web or mail domain on your server, you should create a regular user. To do this, you can refer to our [User Management Guide](../user-guide/users.md#adding-a-user).
+Before adding any web or mail domain on your server, you should create a regular user. To do this, you can refer to our [User Management Guide](../user-guide/users#adding-a-user).
 
 ## Enable two-factor authentication (2FA) for the _admin_ user
 
-Since the **admin** user has full control on the server, as well as elevated privileges, it is **greatly** recommended that you enable 2FA on this account. To do this, you can refer to our [Account Management](../user-guide/account.md#two-factor-authentication-2fa).
+Since the **admin** user has full control on the server, as well as elevated privileges, it is **greatly** recommended that you enable 2FA on this account. To do this, you can refer to our [Account Management](../user-guide/account#two-factor-authentication-2fa).

+ 1 - 1
docs/docs/introduction/getting-started.md

@@ -75,7 +75,7 @@ bash hst-install.sh -h
 ### List of installation options
 
 ::: tip
-An easier way to choose your installation options is by using the [Install string generator](/install.md).
+An easier way to choose your installation options is by using the [Install string generator](/install).
 :::
 
 To choose what software gets installed, you can provide flags to the installation script. You can view the full list of options below.

+ 1 - 1
docs/docs/server-administration/backup-restore.md

@@ -34,7 +34,7 @@ Currently HestiaCP only support restoring backups made using:
 
 ## How to edit the number of backups?
 
-To edit the number of backups, please read the [Packages](../user-guide/packages.md) and [Users](../user-guide/users.md) documentation. You will need to create or edit a package, and assign it to the desired user.
+To edit the number of backups, please read the [Packages](../user-guide/packages) and [Users](../user-guide/users) documentation. You will need to create or edit a package, and assign it to the desired user.
 
 ## Not enough disk space available to preform the backup
 

+ 1 - 1
docs/docs/server-administration/databases.md

@@ -70,7 +70,7 @@ include     /etc/nginx/conf.d/phppgadmin.inc*;
 ## How can I connect from a remote location to the database
 
 By default, connections to port 3306 are disabled in the firewall. Open
-port 3306 in the firewall ([documentation](./firewall.md)), then edit `/etc/mysql/mariadb.conf.d/50-server.cnf`:
+port 3306 in the firewall ([documentation](./firewall)), then edit `/etc/mysql/mariadb.conf.d/50-server.cnf`:
 
 ```bash
 nano /etc/mysql/mariadb.conf.d/50-server.cnf

+ 1 - 1
docs/docs/server-administration/dns.md

@@ -16,7 +16,7 @@ These steps require that you configure the DNS servers of your domain to use you
 
 Preparing the domain and DNS
 
-1. On your Hestia master, [create a DNS Zone](../user-guide/dns.md#adding-a-dns-zone) with the **child-ns** template
+1. On your Hestia master, [create a DNS Zone](../user-guide/dns#adding-a-dns-zone) with the **child-ns** template
 2. On your domain registrar panel, set the name servers of the domain to the Hestia servers
 
 If you are looking at options to minimise DNS-related downtime or for a way to automatically synchronise DNS zones across all your servers, you might consider setting up a DNS cluster.

+ 2 - 2
docs/docs/server-administration/email.md

@@ -116,7 +116,7 @@ No, Cloudflare’s Proxy does not work with email. If you use email hosted on yo
 - TXT record with name **mail.\_domainkey** containing `t=y; o=~DKIM key;`
 - TXT record with name **\_dmarc** containing `v=DMARC1; p=quarantine; sp=quarantine; adkim=s; aspf=s;`
 
-The DKIM key and SPF record can be found in the **Mail Domains** list ([documentation](../user-guide/mail-domains.md#get-dns-records)).
+The DKIM key and SPF record can be found in the **Mail Domains** list ([documentation](../user-guide/mail-domains#get-dns-records)).
 
 ## When sending send emails from my server, they end up in the spam folder
 
@@ -130,7 +130,7 @@ During Hestia’s installation, use the `--sieve` flag. If Hestia is already ins
 
 ## Can I allow access to ManageSieve via an external mail client?
 
-Open port 4190 in the firewall. [Read the firewall documentation](./firewall.md).
+Open port 4190 in the firewall. [Read the firewall documentation](./firewall).
 
 ## How can I enable ManageSieve for Snappymail?
 

+ 1 - 1
docs/docs/server-administration/firewall.md

@@ -16,7 +16,7 @@ After every edit or update the firewall, Hestia will clear the current iptables
 8. Optionally describe the rule’s function.
 9. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
 
-You can also use the [v-add-firewall-rule](../reference/cli.md#v-add-firewall-rule) command.
+You can also use the [v-add-firewall-rule](../reference/cli#v-add-firewall-rule) command.
 
 ## How do I setup an IPSet blacklist or whitelist?
 

+ 2 - 2
docs/docs/server-administration/rest-api.md

@@ -2,7 +2,7 @@
 
 The Hestia REST API is available to perform core functions of the Control Panel. For example, we use it internally to synchronise DNS clusters and to integrate the WHMCS billing system. The API can also be used to create new user accounts, domains, databases or even to build an alternative web interface.
 
-The [API reference](../reference/api.md) provides PHP code samples demonstrating how you can integrate the API into your application or script. However, you also can use any other language to communicate with the API.
+The [API reference](../reference/api) provides PHP code samples demonstrating how you can integrate the API into your application or script. However, you also can use any other language to communicate with the API.
 
 With the release of Hestia v1.6.0, we have introduced a more advanced API system and it will allow non-admin users to use specific commands.
 
@@ -37,7 +37,7 @@ Yes, you can disable the API via the server settings. The file will be deleted f
 
 ## Setup access/secret key authentication
 
-To create an access key, follow [the guide in our documentation](../user-guide/account.md#api-access-keys).
+To create an access key, follow [the guide in our documentation](../user-guide/account#api-access-keys).
 
 If the software you are using already supports the hash format, use `ACCESS_KEY:SECRET_KEY` instead of your old API key.
 

+ 1 - 1
docs/docs/server-administration/web-templates.md

@@ -37,7 +37,7 @@ cp original.sh new.sh
 
 When you are done editing your template, enable it for the desired domain from the control panel.
 
-After modifying an existing template, you need to rebuild the user configuration. This can be done using the [v-rebuild-user](../reference/cli.md#v-rebuild-user) command or the bulk operation in the web interface..
+After modifying an existing template, you need to rebuild the user configuration. This can be done using the [v-rebuild-user](../reference/cli#v-rebuild-user) command or the bulk operation in the web interface..
 
 ### Available variables
 

+ 3 - 3
docs/docs/user-guide/backups.md

@@ -46,7 +46,7 @@ To exclude a specific folder from a domain use the following syntax:
 domain.tld:public_html/wp-content/uploads:public_html/cache
 ```
 
-This will excude both `public_html/wp-content/uploads/` and `public_html/cache/` from that domain.
+This will exclude both `public_html/wp-content/uploads/` and `public_html/cache/` from that domain.
 
 To exclude all domains, use `*`.
 
@@ -60,7 +60,7 @@ To exclude only one or multiple mail account use the following syntax:
 domain.tld:info:support
 ```
 
-This will excude both `info@domain.tld` and `support@domain.tld`.
+This will exclude both `info@domain.tld` and `support@domain.tld`.
 
 To exclude all domains, use `*`.
 
@@ -78,4 +78,4 @@ To exclude all directories, use `*`.
 
 ## Editing the number of backups
 
-To edit the number of backups, please read the [Packages](../user-guide/packages.md) and [Users](../user-guide/users.md) documentation. You will need to create or edit a package, and assign it to the desired user.
+To edit the number of backups, please read the [Packages](../user-guide/packages) and [Users](../user-guide/users) documentation. You will need to create or edit a package, and assign it to the desired user.

+ 1 - 1
docs/docs/user-guide/dns.md

@@ -62,7 +62,7 @@ Adjust the default time-to-live. A shorter TTL means faster changes, but results
 
 ### DNSSEC
 
-Enable DNSSEC to improve security. However, this setting requires some changes to at your domain registrar before it is active. For more information, see the [DNS cluster](../server-administration/dns.md) documentation.
+Enable DNSSEC to improve security. However, this setting requires some changes to at your domain registrar before it is active. For more information, see the [DNS cluster](../server-administration/dns) documentation.
 
 ## Adding a DNS record to a zone
 

+ 1 - 1
docs/docs/user-guide/mail-domains.md

@@ -74,7 +74,7 @@ Enable DKIM for this domain.
 
 If you want to use your own SSL certificate you can enter the SSL certificate in the text area.
 
-If you are having issues with enabling Let’s Encrypt, please refer to our [SSL certificates](../server-administration/ssl-certificates.md) documentation.
+If you are having issues with enabling Let’s Encrypt, please refer to our [SSL certificates](../server-administration/ssl-certificates) documentation.
 
 ### SMTP relay
 

+ 2 - 2
docs/docs/user-guide/users.md

@@ -16,7 +16,7 @@ To manage users, log in as an **administrator** and navigate to the **Users <i c
 
 ## Editing a user
 
-The settings specified below are only available to administrators. For the regular settings, you can refer to the [Account Management](../user-guide/account.md) documentation.
+The settings specified below are only available to administrators. For the regular settings, you can refer to the [Account Management](../user-guide/account) documentation.
 
 To edit a user you can either impersonate them and click the <i class="fas fa-lg fa-fw fa-user-circle"><span class="visually-hidden">user</span></i> icon in the top right, or follow these steps:
 
@@ -68,5 +68,5 @@ To change a user’s PHP CLI version, click the **Advanced Options** button, the
 To change a user’s default name servers, click the **Advanced Options** button, then edit the **Default Name Servers** fields.
 
 ::: warning
-At least 2 default name servers are necessary. This is to provide redundancy, in case one of them fails to answer. In fact, it is suggested that both name servers be on separate servers, for better resilience. If you are the system administrator and would like to set this up, refer to our [DNS Cluster documentation](../server-administration/dns.md#dns-cluster-setup).
+At least 2 default name servers are necessary. This is to provide redundancy, in case one of them fails to answer. In fact, it is suggested that both name servers be on separate servers, for better resilience. If you are the system administrator and would like to set this up, refer to our [DNS Cluster documentation](../server-administration/dns#dns-cluster-setup).
 :::

+ 1 - 1
docs/docs/user-guide/web-domains.md

@@ -71,7 +71,7 @@ If your domain is an [internationalized domain name (IDN)](https://en.wikipedia.
 
 If you want to use your own SSL certificate you can enter the SSL certificate in the text area.
 
-If you are having issues with enabling Let’s Encrypt, please refer to our [SSL certificates](../server-administration/ssl-certificates.md) documentation.
+If you are having issues with enabling Let’s Encrypt, please refer to our [SSL certificates](../server-administration/ssl-certificates) documentation.
 
 ### Changing PHP version