Skip to content

Commit ab91f96

Browse files
AlecRustAlecRust
authored
Remove .md extension from VitePress links (hestiacp#4048)
* Remove .md extension from Vitepress links * Fix exclude typo
1 parent 0de6aee commit ab91f96

File tree

16 files changed

+101
-101
lines changed

16 files changed

+101
-101
lines changed

‎docs/.vitepress/config.js‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ export default defineConfig({
5353
/** @returns {import("vitepress").DefaultTheme.NavItem[]} */
5454
function nav() {
5555
return [
56-
{ text: 'Features', link: '/features.md' },
57-
{ text: 'Install', link: '/install.md' },
58-
{ text: 'Documentation', link: '/docs/introduction/getting-started.md', activeMatch: '/docs/' },
59-
{ text: 'Team', link: '/team.md' },
56+
{ text: 'Features', link: '/features' },
57+
{ text: 'Install', link: '/install' },
58+
{ text: 'Documentation', link: '/docs/introduction/getting-started', activeMatch: '/docs/' },
59+
{ text: 'Team', link: '/team' },
6060
{ text: 'Demo', link: 'https://demo.hestiacp.com:8083/' },
6161
{ text: 'Forum', link: 'https://forum.hestiacp.com/' },
62-
{ text: 'Donate', link: '/donate.md' },
62+
{ text: 'Donate', link: '/donate' },
6363
{
6464
text: `v${version}`,
6565
items: [
@@ -86,77 +86,77 @@ function sidebarDocs() {
8686
text: 'Introduction',
8787
collapsed: false,
8888
items: [
89-
{ text: 'Getting started', link: '/docs/introduction/getting-started.md' },
90-
{ text: 'Best practices', link: '/docs/introduction/best-practices.md' },
89+
{ text: 'Getting started', link: '/docs/introduction/getting-started' },
90+
{ text: 'Best practices', link: '/docs/introduction/best-practices' },
9191
],
9292
},
9393
{
9494
text: 'User guide',
9595
collapsed: false,
9696
items: [
97-
{ text: 'Account', link: '/docs/user-guide/account.md' },
98-
{ text: 'Backups', link: '/docs/user-guide/backups.md' },
99-
{ text: 'Cron jobs', link: '/docs/user-guide/cron-jobs.md' },
100-
{ text: 'Databases', link: '/docs/user-guide/databases.md' },
101-
{ text: 'DNS', link: '/docs/user-guide/dns.md' },
102-
{ text: 'File manager', link: '/docs/user-guide/file-manager.md' },
103-
{ text: 'Mail domains', link: '/docs/user-guide/mail-domains.md' },
104-
{ text: 'Notifications', link: '/docs/user-guide/notifications.md' },
105-
{ text: 'Packages', link: '/docs/user-guide/packages.md' },
106-
{ text: 'Statistics', link: '/docs/user-guide/statistics.md' },
107-
{ text: 'Users', link: '/docs/user-guide/users.md' },
108-
{ text: 'Web domains', link: '/docs/user-guide/web-domains.md' },
97+
{ text: 'Account', link: '/docs/user-guide/account' },
98+
{ text: 'Backups', link: '/docs/user-guide/backups' },
99+
{ text: 'Cron jobs', link: '/docs/user-guide/cron-jobs' },
100+
{ text: 'Databases', link: '/docs/user-guide/databases' },
101+
{ text: 'DNS', link: '/docs/user-guide/dns' },
102+
{ text: 'File manager', link: '/docs/user-guide/file-manager' },
103+
{ text: 'Mail domains', link: '/docs/user-guide/mail-domains' },
104+
{ text: 'Notifications', link: '/docs/user-guide/notifications' },
105+
{ text: 'Packages', link: '/docs/user-guide/packages' },
106+
{ text: 'Statistics', link: '/docs/user-guide/statistics' },
107+
{ text: 'Users', link: '/docs/user-guide/users' },
108+
{ text: 'Web domains', link: '/docs/user-guide/web-domains' },
109109
],
110110
},
111111
{
112112
text: 'Server administration',
113113
collapsed: false,
114114
items: [
115-
{ text: 'Backup & restore', link: '/docs/server-administration/backup-restore.md' },
116-
{ text: 'Configuration', link: '/docs/server-administration/configuration.md' },
117-
{ text: 'Customisation', link: '/docs/server-administration/customisation.md' },
118-
{ text: 'Databases & phpMyAdmin', link: '/docs/server-administration/databases.md' },
119-
{ text: 'DNS clusters & DNSSEC', link: '/docs/server-administration/dns.md' },
120-
{ text: 'Email', link: '/docs/server-administration/email.md' },
121-
{ text: 'File manager', link: '/docs/server-administration/file-manager.md' },
122-
{ text: 'Firewall', link: '/docs/server-administration/firewall.md' },
123-
{ text: 'OS upgrades', link: '/docs/server-administration/os-upgrades.md' },
124-
{ text: 'Rest API', link: '/docs/server-administration/rest-api.md' },
125-
{ text: 'SSL certificates', link: '/docs/server-administration/ssl-certificates.md' },
126-
{ text: 'Web templates & caching', link: '/docs/server-administration/web-templates.md' },
127-
{ text: 'Troubleshooting', link: '/docs/server-administration/troubleshooting.md' },
115+
{ text: 'Backup & restore', link: '/docs/server-administration/backup-restore' },
116+
{ text: 'Configuration', link: '/docs/server-administration/configuration' },
117+
{ text: 'Customisation', link: '/docs/server-administration/customisation' },
118+
{ text: 'Databases & phpMyAdmin', link: '/docs/server-administration/databases' },
119+
{ text: 'DNS clusters & DNSSEC', link: '/docs/server-administration/dns' },
120+
{ text: 'Email', link: '/docs/server-administration/email' },
121+
{ text: 'File manager', link: '/docs/server-administration/file-manager' },
122+
{ text: 'Firewall', link: '/docs/server-administration/firewall' },
123+
{ text: 'OS upgrades', link: '/docs/server-administration/os-upgrades' },
124+
{ text: 'Rest API', link: '/docs/server-administration/rest-api' },
125+
{ text: 'SSL certificates', link: '/docs/server-administration/ssl-certificates' },
126+
{ text: 'Web templates & caching', link: '/docs/server-administration/web-templates' },
127+
{ text: 'Troubleshooting', link: '/docs/server-administration/troubleshooting' },
128128
],
129129
},
130130
{
131131
text: 'Contributing',
132132
collapsed: false,
133133
items: [
134-
{ text: 'Building Packages', link: '/docs/contributing/building.md' },
135-
{ text: 'Development', link: '/docs/contributing/development.md' },
136-
{ text: 'Documentation', link: '/docs/contributing/documentation.md' },
137-
{ text: 'Quick install app', link: '/docs/contributing/quick-install-app.md' },
138-
{ text: 'Testing', link: '/docs/contributing/testing.md' },
139-
{ text: 'Translations', link: '/docs/contributing/translations.md' },
134+
{ text: 'Building Packages', link: '/docs/contributing/building' },
135+
{ text: 'Development', link: '/docs/contributing/development' },
136+
{ text: 'Documentation', link: '/docs/contributing/documentation' },
137+
{ text: 'Quick install app', link: '/docs/contributing/quick-install-app' },
138+
{ text: 'Testing', link: '/docs/contributing/testing' },
139+
{ text: 'Translations', link: '/docs/contributing/translations' },
140140
],
141141
},
142142
{
143143
text: 'Community',
144144
collapsed: false,
145145
items: [
146-
{ text: 'Hestia Nginx Cache', link: '/docs/community/hestia-nginx-cache.md' },
146+
{ text: 'Hestia Nginx Cache', link: '/docs/community/hestia-nginx-cache' },
147147
{
148148
text: 'Ioncube installer for Hestia',
149-
link: '/docs/community/ioncube-hestia-installer.md',
149+
link: '/docs/community/ioncube-hestia-installer',
150150
},
151-
{ text: 'Install script generator', link: '/docs/community/install-script-generator.md' },
151+
{ text: 'Install script generator', link: '/docs/community/install-script-generator' },
152152
],
153153
},
154154
{
155155
text: 'Reference',
156156
collapsed: false,
157157
items: [
158-
{ text: 'API', link: '/docs/reference/api.md' },
159-
{ text: 'CLI', link: '/docs/reference/cli.md' },
158+
{ text: 'API', link: '/docs/reference/api' },
159+
{ text: 'CLI', link: '/docs/reference/cli' },
160160
],
161161
},
162162
];

‎docs/docs/index.md‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,56 @@
22

33
## Getting started
44

5-
- [Getting started](/docs/introduction/getting-started.md)
6-
- [Best practices](/docs/introduction/best-practices.md)
5+
- [Getting started](/docs/introduction/getting-started)
6+
- [Best practices](/docs/introduction/best-practices)
77

88
## User Guide
99

10-
- [Account](/docs/user-guide/account.md)
11-
- [Backups](/docs/user-guide/backups.md)
12-
- [Cron jobs](/docs/user-guide/cron-jobs.md)
13-
- [Databases](/docs/user-guide/databases.md)
14-
- [DNS](/docs/user-guide/dns.md)
15-
- [File manager](/docs/user-guide/file-manager.md)
16-
- [Mail domains](/docs/user-guide/mail-domains.md)
17-
- [Notifications](/docs/user-guide/notifications.md)
18-
- [Packages](/docs/user-guide/packages.md)
19-
- [Statistics](/docs/user-guide/statistics.md)
20-
- [Users](/docs/user-guide/users.md)
21-
- [Web domains](/docs/user-guide/web-domains.md)
10+
- [Account](/docs/user-guide/account)
11+
- [Backups](/docs/user-guide/backups)
12+
- [Cron jobs](/docs/user-guide/cron-jobs)
13+
- [Databases](/docs/user-guide/databases)
14+
- [DNS](/docs/user-guide/dns)
15+
- [File manager](/docs/user-guide/file-manager)
16+
- [Mail domains](/docs/user-guide/mail-domains)
17+
- [Notifications](/docs/user-guide/notifications)
18+
- [Packages](/docs/user-guide/packages)
19+
- [Statistics](/docs/user-guide/statistics)
20+
- [Users](/docs/user-guide/users)
21+
- [Web domains](/docs/user-guide/web-domains)
2222

2323
## Server administration
2424

25-
- [Backup & restore](/docs/server-administration/backup-restore.md)
26-
- [Configuration](/docs/server-administration/configuration.md)
27-
- [Customisation](/docs/server-administration/customisation.md)
28-
- [Databases & phpMyAdmin](/docs/server-administration/databases.md)
29-
- [DNS clusters & DNSSEC](/docs/server-administration/dns.md)
30-
- [Email](/docs/server-administration/email.md)
31-
- [File manager](/docs/server-administration/file-manager.md)
32-
- [Firewall](/docs/server-administration/firewall.md)
33-
- [OS upgrades](/docs/server-administration/os-upgrades.md)
34-
- [Rest API](/docs/server-administration/rest-api.md)
35-
- [SSL certificates](/docs/server-administration/ssl-certificates.md)
36-
- [Web templates & caching](/docs/server-administration/web-templates.md)
37-
- [Troubleshooting](/docs/server-administration/troubleshooting.md)
25+
- [Backup & restore](/docs/server-administration/backup-restore)
26+
- [Configuration](/docs/server-administration/configuration)
27+
- [Customisation](/docs/server-administration/customisation)
28+
- [Databases & phpMyAdmin](/docs/server-administration/databases)
29+
- [DNS clusters & DNSSEC](/docs/server-administration/dns)
30+
- [Email](/docs/server-administration/email)
31+
- [File manager](/docs/server-administration/file-manager)
32+
- [Firewall](/docs/server-administration/firewall)
33+
- [OS upgrades](/docs/server-administration/os-upgrades)
34+
- [Rest API](/docs/server-administration/rest-api)
35+
- [SSL certificates](/docs/server-administration/ssl-certificates)
36+
- [Web templates & caching](/docs/server-administration/web-templates)
37+
- [Troubleshooting](/docs/server-administration/troubleshooting)
3838

3939
## Contributing
4040

41-
- [Building Packages](/docs/contributing/building.md)
42-
- [Development](/docs/contributing/development.md)
43-
- [Documentation](/docs/contributing/documentation.md)
44-
- [Quick install app](/docs/contributing/quick-install-app.md)
45-
- [Testing](/docs/contributing/testing.md)
46-
- [Translations](/docs/contributing/translations.md)
41+
- [Building Packages](/docs/contributing/building)
42+
- [Development](/docs/contributing/development)
43+
- [Documentation](/docs/contributing/documentation)
44+
- [Quick install app](/docs/contributing/quick-install-app)
45+
- [Testing](/docs/contributing/testing)
46+
- [Translations](/docs/contributing/translations)
4747

4848
## Community
4949

50-
- [Hestia Nginx Cache](/docs/community/hestia-nginx-cache.md)
51-
- [Ioncube installer for Hestia](/docs/community/ioncube-hestia-installer.md)
52-
- [Install script generator](/docs/community/install-script-generator.md)
50+
- [Hestia Nginx Cache](/docs/community/hestia-nginx-cache)
51+
- [Ioncube installer for Hestia](/docs/community/ioncube-hestia-installer)
52+
- [Install script generator](/docs/community/install-script-generator)
5353

5454
## Reference
5555

56-
- [API](/docs/reference/api.md)
57-
- [CLI](/docs/reference/cli.md)
56+
- [API](/docs/reference/api)
57+
- [CLI](/docs/reference/cli)

‎docs/docs/introduction/best-practices.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Managing a server is not easy. Here are some best practices you should try to ad
88
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**!
99
:::
1010

11-
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).
11+
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).
1212

1313
## Enable two-factor authentication (2FA) for the _admin_ user
1414

15-
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).
15+
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).

‎docs/docs/introduction/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ bash hst-install.sh -h
7575
### List of installation options
7676

7777
::: tip
78-
An easier way to choose your installation options is by using the [Install string generator](/install.md).
78+
An easier way to choose your installation options is by using the [Install string generator](/install).
7979
:::
8080

8181
To choose what software gets installed, you can provide flags to the installation script. You can view the full list of options below.

‎docs/docs/server-administration/backup-restore.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Currently HestiaCP only support restoring backups made using:
3434

3535
## How to edit the number of backups?
3636

37-
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.
37+
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.
3838

3939
## Not enough disk space available to preform the backup
4040

‎docs/docs/server-administration/databases.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ include /etc/nginx/conf.d/phppgadmin.inc*;
7070
## How can I connect from a remote location to the database
7171

7272
By default, connections to port 3306 are disabled in the firewall. Open
73-
port 3306 in the firewall ([documentation](./firewall.md)), then edit `/etc/mysql/mariadb.conf.d/50-server.cnf`:
73+
port 3306 in the firewall ([documentation](./firewall)), then edit `/etc/mysql/mariadb.conf.d/50-server.cnf`:
7474

7575
```bash
7676
nano /etc/mysql/mariadb.conf.d/50-server.cnf

‎docs/docs/server-administration/dns.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ These steps require that you configure the DNS servers of your domain to use you
1616

1717
Preparing the domain and DNS
1818

19-
1. On your Hestia master, [create a DNS Zone](../user-guide/dns.md#adding-a-dns-zone) with the **child-ns** template
19+
1. On your Hestia master, [create a DNS Zone](../user-guide/dns#adding-a-dns-zone) with the **child-ns** template
2020
2. On your domain registrar panel, set the name servers of the domain to the Hestia servers
2121

2222
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.

‎docs/docs/server-administration/email.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ No, Cloudflare’s Proxy does not work with email. If you use email hosted on yo
116116
- TXT record with name **mail.\_domainkey** containing `t=y; o=~DKIM key;`
117117
- TXT record with name **\_dmarc** containing `v=DMARC1; p=quarantine; sp=quarantine; adkim=s; aspf=s;`
118118

119-
The DKIM key and SPF record can be found in the **Mail Domains** list ([documentation](../user-guide/mail-domains.md#get-dns-records)).
119+
The DKIM key and SPF record can be found in the **Mail Domains** list ([documentation](../user-guide/mail-domains#get-dns-records)).
120120

121121
## When sending send emails from my server, they end up in the spam folder
122122

@@ -130,7 +130,7 @@ During Hestia’s installation, use the `--sieve` flag. If Hestia is already ins
130130

131131
## Can I allow access to ManageSieve via an external mail client?
132132

133-
Open port 4190 in the firewall. [Read the firewall documentation](./firewall.md).
133+
Open port 4190 in the firewall. [Read the firewall documentation](./firewall).
134134

135135
## How can I enable ManageSieve for Snappymail?
136136

‎docs/docs/server-administration/firewall.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ After every edit or update the firewall, Hestia will clear the current iptables
1616
8. Optionally describe the rule’s function.
1717
9. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
1818

19-
You can also use the [v-add-firewall-rule](../reference/cli.md#v-add-firewall-rule) command.
19+
You can also use the [v-add-firewall-rule](../reference/cli#v-add-firewall-rule) command.
2020

2121
## How do I setup an IPSet blacklist or whitelist?
2222

‎docs/docs/server-administration/rest-api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
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.
5+
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.
66

77
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.
88

@@ -37,7 +37,7 @@ Yes, you can disable the API via the server settings. The file will be deleted f
3737

3838
## Setup access/secret key authentication
3939

40-
To create an access key, follow [the guide in our documentation](../user-guide/account.md#api-access-keys).
40+
To create an access key, follow [the guide in our documentation](../user-guide/account#api-access-keys).
4141

4242
If the software you are using already supports the hash format, use `ACCESS_KEY:SECRET_KEY` instead of your old API key.
4343

0 commit comments

Comments
 (0)