From 3193a1cc9f7cd23d07e7a3bddce5b2f1a73abf7d Mon Sep 17 00:00:00 2001 From: Quentin Gabriele Date: Fri, 13 Sep 2024 17:05:41 +0200 Subject: [PATCH] readme --- README.md | 88 +++++++++++++++++++++++++++++++++++++++----------- config/seo.php | 5 +-- 2 files changed, 72 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e18d797..79a860a 100644 --- a/README.md +++ b/README.md @@ -56,30 +56,80 @@ return [ | Default Description |-------------------------------------------------------------------------- | - | This is the default value used for , , - | + | This is the default value used for , + | , | */ 'description' => null, + /* + |-------------------------------------------------------------------------- + | Default Author + |-------------------------------------------------------------------------- + | + | This is the default value used for + | + */ + 'author' => null, + + /* + |-------------------------------------------------------------------------- + | Default Generator + |-------------------------------------------------------------------------- + | + | This is the default value used for + | + */ + 'generator' => null, + /* |-------------------------------------------------------------------------- | Default Keywords |-------------------------------------------------------------------------- | - | This is the default value used for . - | Supports string or array of strings. + | This is the default value used for + | Types supported: string or array of strings | */ 'keywords' => null, + /* + |-------------------------------------------------------------------------- + | Default Referrer + |-------------------------------------------------------------------------- + | + | This is the default value used for + | + */ + 'referrer' => null, + + /* + |-------------------------------------------------------------------------- + | Default Theme color + |-------------------------------------------------------------------------- + | + | This is the default value used for + | + */ + 'theme-color' => null, + + /* + |-------------------------------------------------------------------------- + | Default Color Scheme + |-------------------------------------------------------------------------- + | + | This is the default value used for + | + */ + 'color-scheme' => null, + /* |-------------------------------------------------------------------------- | Default Image path |-------------------------------------------------------------------------- | | This is the default value used for , - | You can use a relative path (e.g., "/opengraph.png") or a full URL (e.g., "https://example.com/opengraph.png") + | You can use relative path like "/opengraph.png" or url like "https://example.com/opengraph.png" | */ 'image' => null, @@ -89,19 +139,19 @@ return [ | Default Robots |-------------------------------------------------------------------------- | - | This is the default value for the tag. - | Refer to Google’s documentation: https://developers.google.com/search/docs/crawling-indexing/robots-meta-tag?hl=en + | This is the default value used for + | See Google documentation here: https://developers.google.com/search/docs/crawling-indexing/robots-meta-tag?hl=fr#directives | */ 'robots' => 'max-snippet:-1,max-image-preview:large,max-video-preview:-1', /* |-------------------------------------------------------------------------- - | Default Sitemap Path + | Default Sitemap path |-------------------------------------------------------------------------- | - | This is the default value for the tag. - | You can use a relative path (e.g., "/sitemap.xml") or a full URL (e.g., "https://example.com/sitemap.xml") + | This is the default value used for + | You can use relative path like "/sitemap.xml" or url like "https://example.com/sitemap.xml" | */ 'sitemap' => null, @@ -116,8 +166,8 @@ return [ | Default Site Name |-------------------------------------------------------------------------- | - | This is the default value for . - | If null, config('app.name') will be used. + | This is the default value used for + | If null: config('app.name') is used. | */ 'site_name' => null, @@ -127,8 +177,8 @@ return [ | Default Determiner |-------------------------------------------------------------------------- | - | This is the default value for . - | Possible values: a, an, the, "", auto + | This is the default value used for + | Possible values are: a, an, the, "", auto | */ 'determiner' => '', @@ -140,10 +190,10 @@ return [ 'twitter' => [ /* |-------------------------------------------------------------------------- - | Default Twitter Username + | Default Twitter username |-------------------------------------------------------------------------- | - | This is the default value for . + | This is the default value used for | Example: @X | */ @@ -156,11 +206,11 @@ return [ 'schema' => [ /* |-------------------------------------------------------------------------- - | Default WebPage Schema + | Default WebPage schema |-------------------------------------------------------------------------- | - | This is the default value for the schema.org WebPage. - | For available properties, refer to https://schema.org/WebPage. + | This is the default value used for the schema WebPage + | @see https://schema.org/WebPage for all available properties | */ 'webpage' => [], diff --git a/config/seo.php b/config/seo.php index 67009f2..d317da6 100644 --- a/config/seo.php +++ b/config/seo.php @@ -18,7 +18,8 @@ | Default Description |-------------------------------------------------------------------------- | - | This is the default value used for , , + | This is the default value used for , + | , | */ 'description' => null, @@ -49,7 +50,7 @@ |-------------------------------------------------------------------------- | | This is the default value used for - | Type supported: string or array of strings + | Types supported: string or array of strings | */ 'keywords' => null,