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

remove aliases page #8512

Closed
wants to merge 5 commits into from
Closed
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
2 changes: 1 addition & 1 deletion old-translations/de/guides/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Deine in `src/` gespeicherten Bilder können von Komponenten (`.astro`, `.mdx` u

Wir empfehlen, dass du deine Bilder in [`public/`](#public) aufbewahrst oder sie [remote](#bilder-von-einem-cms-oder-cdn-verwenden) speicherst, wenn du Markdown-Dateien verwenden musst.

Importiere sie aus einem **relativen Dateipfad** oder [import alias](/de/guides/aliases/) in eine beliebige Komponentendatei und verwende dann den Import als `src`-Attribut des Bildes.
Importiere sie aus einem **relativen Dateipfad** oder [import alias](/de/guides/imports/#aliases) in eine beliebige Komponentendatei und verwende dann den Import als `src`-Attribut des Bildes.


```astro
Expand Down
2 changes: 1 addition & 1 deletion old-translations/fr/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Vos images stockées dans `src/` peuvent être utilisées par les composants (`.

Nous recommandons de garder vos images dans [`public/`](#public) ou de les stocker [à distance](#utilisation-des-images-depuis-un-cms-ou-un-cdn) si vous devez utiliser des fichiers Markdown.

Importez-les depuis un **chemin de fichier relatif** ou un [alias d'import](/fr/guides/aliases/) dans n'importe quel fichier composant et utilisez ensuite l'import comme attribut `src` de l'image.
Importez-les depuis un **chemin de fichier relatif** ou un [alias d'import](/fr/guides/imports/#aliases) dans n'importe quel fichier composant et utilisez ensuite l'import comme attribut `src` de l'image.

```astro
---
Expand Down
2 changes: 1 addition & 1 deletion old-translations/ja/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ import rocket from '../images/rocket.svg';

Markdownファイルを利用する必要がある場合、[`public/`へ配置する](#public)か[CMSやCDN上の画像を利用](#cmsやcdn上の画像利用)することをお勧めします。

画像を**相対ファイルパス**または[importエイリアス](/ja/guides/aliases/)を利用してコンポーネントファイル内でインポートし、画像の`src`属性として利用できます。
画像を**相対ファイルパス**または[importエイリアス](/ja/guides/imports/#aliases)を利用してコンポーネントファイル内でインポートし、画像の`src`属性として利用できます。


```astro
Expand Down
2 changes: 1 addition & 1 deletion old-translations/zh-CN/guides/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ import rocket from '../images/rocket.svg';

如果你必须使用 Markdown 文档,我们建议你将图像保存在 ['public/'](#public) 中或 [远程](#使用-cms-或-cdn-上的图片) 存储他们。

从任何组件文档中的 **相对文档路径** 或 [导入别名](/zh-cn/guides/aliases/) 导入它们,然后像使用 `src`属性一样使用。
从任何组件文档中的 **相对文档路径** 或 [导入别名](/zh-cn/guides/imports/#aliases) 导入它们,然后像使用 `src`属性一样使用。

```astro
---
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/de/guides/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Du kannst TypeScript so konfigurieren, dass Typ-Importe in deiner `.tsconfig`-Da

## Import-Aliase

Astro unterstützt [Import-Aliase](/de/guides/aliases/), die du in deiner `tsconfig.json` & `jsconfig.json` `paths` Konfiguration definierst. [Lies unsere Anleitung](/de/guides/aliases/), um mehr zu erfahren.
Astro unterstützt [Import-Aliase](/de/guides/imports/#aliases), die du in deiner `tsconfig.json` & `jsconfig.json` `paths` Konfiguration definierst. [Lies unsere Anleitung](/de/guides/imports/#aliases), um mehr zu erfahren.


```astro title="src/pages/about/nate.astro" "@components" "@layouts"
Expand Down
47 changes: 0 additions & 47 deletions src/content/docs/en/guides/aliases.mdx

This file was deleted.

6 changes: 3 additions & 3 deletions src/content/docs/en/guides/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ import myImage from '../assets/my_image.png'; // Image is 1600x900

The format of the `src` value of your image file depends on where your image file is located:

- **Local images in `src/`** - you must **also import the image** using a relative file path or configure and use an [import alias](/en/guides/aliases/). Then use the import name as the `src` value:
- **Local images in `src/`** - you must **also import the image** using a relative file path or configure and use an [import alias](/en/guides/imports/#aliases). Then use the import name as the `src` value:

```astro title="src/pages/index.astro" "myImportedImage" "{myImportedImage}"
---
Expand Down Expand Up @@ -405,7 +405,7 @@ It accepts all HTML `<img>` tag properties, and the only required property is `s

#### Local images in `src/`

Local images must be **imported from the relative path** from the existing `.astro` file, or configure and use an [import alias](/en/guides/aliases/). Then, you can access the image's `src` and other properties to use in the `<img>` tag.
Local images must be **imported from the relative path** from the existing `.astro` file, or configure and use an [import alias](/en/guides/imports/#aliases). Then, you can access the image's `src` and other properties to use in the `<img>` tag.

For example, use the image's own `height` and `width` properties to avoid CLS and improve Core Web Vitals.

Expand Down Expand Up @@ -781,7 +781,7 @@ If necessary, also update your `src/env.d.ts` file to replace the `astro/client-

#### Remove the `~/assets` import alias

This import alias is no longer included by default with `astro:assets`. If you were using this alias with experimental assets, you must convert them to relative file paths, or [create your own import aliases](/en/guides/aliases/).
This import alias is no longer included by default with `astro:assets`. If you were using this alias with experimental assets, you must convert them to relative file paths, or [create your own import aliases](/en/guides/imports/#aliases).

```astro title="src/pages/posts/post-1.astro" del={2} ins={3}
---
Expand Down
45 changes: 45 additions & 0 deletions src/content/docs/en/guides/imports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,51 @@ It can also be useful to place images in the `public/` folder as explained on th
Adding **alt text** to `<img>` tags is encouraged for accessibility! Don't forget to add an `alt="a helpful description"` attribute to your image elements. You can just leave the attribute empty if the image is purely decorative.
:::

## Aliases

An **alias** is a way to create shortcuts for your imports.

Aliases can help improve the development experience in codebases with many directories or relative imports.

```astro title="src/pages/about/company.astro" del="../../components" del="../../assets"
---
import Button from '../../components/controls/Button.astro';
import logoUrl from '../../assets/logo.png?url';
---
```

In this example, a developer would need to understand the tree relationship between `src/pages/about/company.astro`, `src/components/controls/Button.astro`, and `src/assets/logo.png`. And then, if the `company.astro` file were to be moved, these imports would also need to be updated.

You can add import aliases from either `tsconfig.json` or `jsconfig.json`.

```json title="tsconfig.json" ins={5-6}
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@components/*": ["src/components/*"],
"@assets/*": ["src/assets/*"]
}
}
}
```

:::note
Make sure `compilerOptions.baseUrl` is set so the aliased paths can be resolved.
:::

The development server will automatically restart after this configuration change. You can now import using the aliases anywhere in your project:

```astro title="src/pages/about/company.astro" ins="@components" ins="@assets"
---
import Button from '@components/controls/Button.astro';
import logoUrl from '@assets/logo.png?url';
---
```

These aliases are also integrated automatically into [VS Code](https://code.visualstudio.com/docs/languages/jsconfig) and other editors.


## `Astro.glob()`

[`Astro.glob()`](/en/reference/api-reference/#astroglob) is a way to import many files at once.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/en/guides/markdown-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Astro provides some extra, built-in Markdown features available when using Markd

### Frontmatter `layout`

Astro provides [Markdown and MDX pages](/en/basics/astro-pages/#markdownmdx-pages) (located within `src/pages/`) with a special frontmatter `layout` property that can specify a relative path (or [alias](/en/guides/aliases/)) to an Astro [layout component](/en/basics/layouts/#markdownmdx-layouts).
Astro provides [Markdown and MDX pages](/en/basics/astro-pages/#markdownmdx-pages) (located within `src/pages/`) with a special frontmatter `layout` property that can specify a relative path (or [alias](/en/guides/imports/#aliases)) to an Astro [layout component](/en/basics/layouts/#markdownmdx-layouts).

```markdown {3}
---
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/en/guides/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ You can configure TypeScript to enforce type imports in your `tsconfig.json` fil

## Import Aliases

Astro supports [import aliases](/en/guides/aliases/) that you define in your `tsconfig.json` & `jsconfig.json` `paths` configuration. [Read our guide](/en/guides/aliases/) to learn more.
Astro supports [import aliases](/en/guides/imports/#aliases) that you define in your `tsconfig.json` & `jsconfig.json` `paths` configuration. [Read our guide](/en/guides/imports/#aliases) to learn more.


```astro title="src/pages/about/nate.astro" "@components" "@layouts"
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/es/guides/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ import myImage from '../assets/my_image.png'; // La imagen es 1600x900

El formato del valor `src` de tu archivo de imagen depende de dónde esté ubicado tu archivo de imagen:

- **Imágenes locales en `src/`** - también debes **importar la imagen** utilizando una ruta de archivo relativa o configurar y usar un [alias de importación](/es/guides/aliases/). Luego usa el nombre de importación como valor de `src`:
- **Imágenes locales en `src/`** - también debes **importar la imagen** utilizando una ruta de archivo relativa o configurar y usar un [alias de importación](/es/guides/imports/#aliases). Luego usa el nombre de importación como valor de `src`:

```astro title="src/pages/index.astro" "myImportedImage" "{myImportedImage}"
---
Expand Down Expand Up @@ -404,7 +404,7 @@ Esta acepta todas las propiedades de la etiqueta HTML `<img>`, y la única propi

#### Imágenes locales en `src/`

Las imágenes locales deben ser **importadas desde la ruta relativa** al archivo `.astro` existente, o configurar y usar un [alias de importación](/es/guides/aliases/). Luego, puedes acceder a la propiedad `src` de la imagen y otras propiedades para usar en la etiqueta `<img>`.
Las imágenes locales deben ser **importadas desde la ruta relativa** al archivo `.astro` existente, o configurar y usar un [alias de importación](/es/guides/imports/#aliases). Luego, puedes acceder a la propiedad `src` de la imagen y otras propiedades para usar en la etiqueta `<img>`.

Por ejemplo, utiliza las propiedades `height` y `width` propias de la imagen para evitar CLS y mejorar los Core Web Vitals.

Expand Down Expand Up @@ -780,7 +780,7 @@ Si es necesario, también actualiza tu archivo `src/env.d.ts` para reemplazar la

#### Eliminar el alias de importación `~/assets`

Este alias de importación ya no se incluye por defecto con `astro:assets`. Si estabas usando este alias con assets experimentales, debes convertirlos a rutas de archivo relativas o [crear tus propios alias de importación](/es/guides/aliases/).
Este alias de importación ya no se incluye por defecto con `astro:assets`. Si estabas usando este alias con assets experimentales, debes convertirlos a rutas de archivo relativas o [crear tus propios alias de importación](/es/guides/imports/#aliases).

```astro title="src/pages/posts/post-1.astro" del={2} ins={3}
---
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/es/guides/markdown-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Astro provee algunas características adicionales incorporadas disponibles a la

### `layout` en el Frontmatter

Astro provee a [las páginas de Markdown y MDX](/es/basics/astro-pages/#páginas-markdownmdx) (localizadas en `src/pages/`) una propiedad especial en el frontmatter para `layout` que define la ruta relativa (o un [alias](/es/guides/aliases/)) a un [componente plantilla](/es/basics/layouts/) de Astro.
Astro provee a [las páginas de Markdown y MDX](/es/basics/astro-pages/#páginas-markdownmdx) (localizadas en `src/pages/`) una propiedad especial en el frontmatter para `layout` que define la ruta relativa (o un [alias](/es/guides/imports/#aliases)) a un [componente plantilla](/es/basics/layouts/) de Astro.

```markdown {3}
---
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/es/guides/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Puedes configurar TypeScript para que obligue a realizar importaciones de tipos

## Alias de importación

Astro es compatible con [alias de importación](/es/guides/aliases/) definidos en la configuración `tsconfig.json` o `jsconfig.json` usando `paths`. [Lee nuestra guía](/es/guides/aliases/) para saber más.
Astro es compatible con [alias de importación](/es/guides/imports/#aliases) definidos en la configuración `tsconfig.json` o `jsconfig.json` usando `paths`. [Lee nuestra guía](/es/guides/imports/#aliases) para saber más.


```astro title="src/pages/about/nate.astro" "@components" "@layouts"
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/es/install-and-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ Aquí te dejamos algunas sugerencias para explorar a continuación. Puedes leerl
<LinkCard
title="Alias de importación"
description="Crea accesos directos convenientes para tus importaciones de archivos."
href="/es/guides/aliases/"
href="/es/guides/imports/#aliases"
/>
<LinkCard
title="Variables de entorno"
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/fr/guides/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ import myImage from '../assets/my_image.png'; // Image est en 1600x900

Le format de la valeur `src` de votre fichier image dépend de l'endroit où se trouve votre fichier image :

- **Images locales dans `src/`** - vous devez **aussi importer l'image** en utilisant un chemin de fichier relatif ou configurer et utiliser un [alias d'importation](/fr/guides/aliases/). Utilisez ensuite le nom de l'importation comme valeur `src` :
- **Images locales dans `src/`** - vous devez **aussi importer l'image** en utilisant un chemin de fichier relatif ou configurer et utiliser un [alias d'importation](/fr/guides/imports/#aliases). Utilisez ensuite le nom de l'importation comme valeur `src` :

```astro title="src/pages/index.astro" "myImportedImage" "{myImportedImage}"
---
Expand Down Expand Up @@ -406,7 +406,7 @@ Elle accepte toutes les propriétés de la balise HTML `<img>` , et la seule pro

#### Images locales dans `src/`

Les images locales doivent être **importées à partir du chemin relatif** du fichier `.astro` existant, ou configurer et utiliser un [alias d'importation]](/fr/guides/aliases/). Ensuite, vous pouvez accéder au `src` de l'image et à d'autres propriétés à utiliser dans la balise `<img>`.
Les images locales doivent être **importées à partir du chemin relatif** du fichier `.astro` existant, ou configurer et utiliser un [alias d'importation]](/fr/guides/imports/#aliases). Ensuite, vous pouvez accéder au `src` de l'image et à d'autres propriétés à utiliser dans la balise `<img>`.

Par exemple, utilisez les propriétés `height` et `width` de l'image pour éviter le CLS et améliorer Core Web Vitals.

Expand Down Expand Up @@ -782,7 +782,7 @@ Si nécessaire, mettez également à jour votre fichier `src/env.d.ts` pour remp

#### Supprimer l'alias d'importation `~/assets`

Cet alias d'importation n'est plus inclus par défaut avec `astro:assets`. Si vous utilisiez cet alias avec des actifs expérimentaux, vous devez les convertir en chemins de fichiers relatifs, ou [créer vos propres alias d'importation](/fr/guides/aliases/).
Cet alias d'importation n'est plus inclus par défaut avec `astro:assets`. Si vous utilisiez cet alias avec des actifs expérimentaux, vous devez les convertir en chemins de fichiers relatifs, ou [créer vos propres alias d'importation](/fr/guides/imports/#aliases).

```astro title="src/pages/posts/post-1.astro" del={2} ins={3}
---
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/fr/guides/markdown-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Astro offre quelques fonctions Markdown supplémentaires intégrées, disponible

### Frontmatter `layout`

Astro fournit des [pages Markdown et MDX](/fr/basics/astro-pages/#pages-markdownmdx) (situées dans `src/pages/`) avec une propriété spéciale `layout` qui peut spécifier un chemin relatif (ou [alias](/fr/guides/aliases/)) vers un [composant de mise en page](/fr/basics/layouts/#mises-en-page-markdownmdx) Astro.
Astro fournit des [pages Markdown et MDX](/fr/basics/astro-pages/#pages-markdownmdx) (situées dans `src/pages/`) avec une propriété spéciale `layout` qui peut spécifier un chemin relatif (ou [alias](/fr/guides/imports/#aliases)) vers un [composant de mise en page](/fr/basics/layouts/#mises-en-page-markdownmdx) Astro.

```markdown {3}
---
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/fr/guides/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Vous pouvez configurer TypeScript pour qu'il applique les importations de types

## Alias d'importation

Astro supporte les [alias d'importation](/fr/guides/aliases/) que vous définissez dans votre configuration `tsconfig.json` & `jsconfig.json` `paths`. [Lisez notre guide](/fr/guides/aliases/) pour en savoir plus.
Astro supporte les [alias d'importation](/fr/guides/imports/#aliases) que vous définissez dans votre configuration `tsconfig.json` & `jsconfig.json` `paths`. [Lisez notre guide](/fr/guides/imports/#aliases) pour en savoir plus.


```astro title="src/pages/about/nate.astro" "@components" "@layouts"
Expand Down
Loading
Loading