From 36422ccbb99dc3b7cfed315c338798e28c399dad Mon Sep 17 00:00:00 2001 From: dc7290 Date: Sun, 12 Jun 2022 19:30:54 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Added=20page=20abo?= =?UTF-8?q?ut=20external=20images?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs/01-intro.md | 1 + docs/docs/03-Features/01-external-images.md | 33 +++++++++++++++++++ docs/docs/03-Features/_category_.json | 9 +++++ .../01-basic-configuration.md | 0 .../02-plugin-configuration.md | 0 .../_category_.json | 2 +- .../docs/{04-structure.md => 05-structure.md} | 0 .../{05-comparison.md => 06-comparison.md} | 0 docs/docs/{06-examples.md => 07-examples.md} | 0 docs/docs/08-planned-features.md | 13 -------- docs/docs/{07-qa.md => 08-qa.md} | 0 docs/docs/09-planned-features.md | 10 ++++++ 12 files changed, 54 insertions(+), 14 deletions(-) create mode 100644 docs/docs/03-Features/01-external-images.md create mode 100644 docs/docs/03-Features/_category_.json rename docs/docs/{03-Configuration => 04-Configurations}/01-basic-configuration.md (100%) rename docs/docs/{03-Configuration => 04-Configurations}/02-plugin-configuration.md (100%) rename docs/docs/{03-Configuration => 04-Configurations}/_category_.json (90%) rename docs/docs/{04-structure.md => 05-structure.md} (100%) rename docs/docs/{05-comparison.md => 06-comparison.md} (100%) rename docs/docs/{06-examples.md => 07-examples.md} (100%) delete mode 100644 docs/docs/08-planned-features.md rename docs/docs/{07-qa.md => 08-qa.md} (100%) create mode 100644 docs/docs/09-planned-features.md diff --git a/docs/docs/01-intro.md b/docs/docs/01-intro.md index 49c35442..fc65a34f 100644 --- a/docs/docs/01-intro.md +++ b/docs/docs/01-intro.md @@ -20,6 +20,7 @@ This makes it possible to build a high performance website with this solution, w - Optimize images at build time. - All options for `next/image` available - Convert formats (png → webp, etc.) +- Download external images locally. - Using `sharp`, so it's fast. - Cache prevents repeating the same optimization - Support TypeScript diff --git a/docs/docs/03-Features/01-external-images.md b/docs/docs/03-Features/01-external-images.md new file mode 100644 index 00000000..7d306c8d --- /dev/null +++ b/docs/docs/03-Features/01-external-images.md @@ -0,0 +1,33 @@ +--- +description: This page introduces the handling of external images. +--- + +# External images + +This feature automatically downloads images locally if an external image URL is specified in src. +This, like the other features, works at build time and does not affect development speed. + +## Usage + +```jsx + +``` + +When in production, it will be rendered as follows. (Only important parts are shown.) + +```jsx + +``` + +During development, as with local images, no optimization is performed. +Also, no downloading to local is performed. + +```jsx + +``` diff --git a/docs/docs/03-Features/_category_.json b/docs/docs/03-Features/_category_.json new file mode 100644 index 00000000..02fed793 --- /dev/null +++ b/docs/docs/03-Features/_category_.json @@ -0,0 +1,9 @@ +{ + "position": 3, + "className": "red", + "link": { + "type": "generated-index", + "title": "Features", + "description": "List of Main Features." + } +} diff --git a/docs/docs/03-Configuration/01-basic-configuration.md b/docs/docs/04-Configurations/01-basic-configuration.md similarity index 100% rename from docs/docs/03-Configuration/01-basic-configuration.md rename to docs/docs/04-Configurations/01-basic-configuration.md diff --git a/docs/docs/03-Configuration/02-plugin-configuration.md b/docs/docs/04-Configurations/02-plugin-configuration.md similarity index 100% rename from docs/docs/03-Configuration/02-plugin-configuration.md rename to docs/docs/04-Configurations/02-plugin-configuration.md diff --git a/docs/docs/03-Configuration/_category_.json b/docs/docs/04-Configurations/_category_.json similarity index 90% rename from docs/docs/03-Configuration/_category_.json rename to docs/docs/04-Configurations/_category_.json index 63bcbb25..7676c27c 100644 --- a/docs/docs/03-Configuration/_category_.json +++ b/docs/docs/04-Configurations/_category_.json @@ -1,5 +1,5 @@ { - "position": 3, + "position": 4, "className": "red", "link": { "type": "generated-index", diff --git a/docs/docs/04-structure.md b/docs/docs/05-structure.md similarity index 100% rename from docs/docs/04-structure.md rename to docs/docs/05-structure.md diff --git a/docs/docs/05-comparison.md b/docs/docs/06-comparison.md similarity index 100% rename from docs/docs/05-comparison.md rename to docs/docs/06-comparison.md diff --git a/docs/docs/06-examples.md b/docs/docs/07-examples.md similarity index 100% rename from docs/docs/06-examples.md rename to docs/docs/07-examples.md diff --git a/docs/docs/08-planned-features.md b/docs/docs/08-planned-features.md deleted file mode 100644 index 6ee9dace..00000000 --- a/docs/docs/08-planned-features.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: This page is to introduce examples of use. ---- - -# Planned Features - -## Download External Images - -We are planning the ability to save external images locally when they are specified. - -:::caution -This API is in the planning stage and is subject to change in practice. -::: diff --git a/docs/docs/07-qa.md b/docs/docs/08-qa.md similarity index 100% rename from docs/docs/07-qa.md rename to docs/docs/08-qa.md diff --git a/docs/docs/09-planned-features.md b/docs/docs/09-planned-features.md new file mode 100644 index 00000000..03b7e681 --- /dev/null +++ b/docs/docs/09-planned-features.md @@ -0,0 +1,10 @@ +--- +description: This page is to introduce examples of use. +draft: true +--- + +# Planned Features + +:::caution +There API is in the planning stage and is subject to change in practice. +:::