Docs folder standardization and other fixes

yii2-extensions · Apr 14, 2024 · b43ba93 · b43ba93
1 parent ff94ae8
commit b43ba93
Show file tree

Hide file tree

Showing 9 changed files with 62 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -20,10 +20,10 @@
     </a>
     <a href="https://github.com/yii2-extensions/app-basic/actions/workflows/static.yml" target="_blank">
         <img src="https://img.shields.io/badge/PHPStan%20level-5-blue" alt="PHPStan level">
-    </a>    
+    </a>
     <a href="https://github.styleci.io/repos/698621511?branch=main" target="_blank">
         <img src="https://github.styleci.io/repos/698621511/shield?branch=main" alt="Code style">
-    </a>        
+    </a>
 </p>
 
 </br>
@@ -34,7 +34,7 @@ Web Application Basic of Yii Version 2. <a href="https://www.yiiframework.com/"
 
 </br>
 
-![app-basic](docs/home.png)
+![app-basic](docs/images/home.png)
 
 </br>
 
@@ -85,31 +85,25 @@ root
 The web application contains:
 
 - [x] Pages - [Screenshots]:
-    - [about](docs/about.png)
-    - [contact](docs/contact.png)
-    - [404](docs/404.png)
+  - [about](docs/images/about.png)
+  - [contact](docs/images/contact.png)
+  - [404](docs/images/404.png)
 
-<p align="justify">
 It includes all commonly used configurations that would allow you to focus on adding new
 features to your application.
-</P>
 
 ## Installation
 
-<p align="justify">
-If you do not have <a href="http://getcomposer.org/" title="Composer" target="_blank">Composer</a>, you may install it by following the instructions at <a href="http://getcomposer.org/doc/00-intro.md#installation-nix" title="getcomposer.org" target="_blank">getcomposer.org</a>.
-</p>
+If you do not have <a href="https://getcomposer.org/" title="Composer" target="_blank">Composer</a>, you may install it by following the instructions at <a href="https://getcomposer.org/doc/00-intro.md#installation-nix" title="getcomposer.org" target="_blank">getcomposer.org</a>.
 
 You can then install this project app-basic using the following command:
 
 ```shell
 composer create-project --prefer-dist --stability=dev yii2-extensions/app-basic myapp
 ```
 
-<p align="justify">
 Now you should be able to access the application through the following URL, assuming `public` is the directory
 directly under the Web root.
-</p>
 
 __*Virtual Host:*__
 
@@ -131,18 +125,14 @@ __Console commands:__
 
 ## Generate translations
 
-<p align="justify">
 To generate the Yii Web Application Basic translations, you can change the language settings in the configuration file.
-<p>
 
 ```
 config/messages.php
 ```
 
-<p align="justify">
  Automatically the generator will create the folder of your language in `src/Framework/resource/message`,
  If any translation is needed, you can open an issue to add it.
-</p>
 
 Root directory
 
@@ -152,13 +142,15 @@ Root directory
 
 ## Tests
 
-~~~
+```shell
 // download all composer dependencies root project
 $ composer update --prefer-dist -vvv
+```
 
+```shell
 // run all tests with code coverage
 $ vendor/bin/codecept run --coverage-xml
-~~~
+```
 
 ## Support versions Yii2
 

diff --git a/docs/404.png → docs/images/404.png b/docs/404.png → docs/images/404.png
diff --git a/docs/about.png → docs/images/about.png b/docs/about.png → docs/images/about.png
diff --git a/docs/contact.png → docs/images/contact.png b/docs/contact.png → docs/images/contact.png
diff --git a/docs/home.png → docs/images/home.png b/docs/home.png → docs/images/home.png
diff --git a/public/image/yii.svg b/public/image/yii.svg
diff --git a/public/image/yiiframework.svg b/public/image/yiiframework.svg
diff --git a/src/Framework/resource/layout/main.php b/src/Framework/resource/layout/main.php
@@ -13,27 +13,26 @@
  */
 AppAsset::register($this);
 ?>
-<?php $this->beginPage() ?>
-    <!DOCTYPE html>
-    <?= Html::widget()->attributes(['lang' => Yii::$app->language, 'data-bs-theme' => 'auto'])->begin() ?>
-        <?= $this->render('head') ?>
-        <?php $this->beginBody() ?>
-            <?= Body::widget()->class('d-flex')->begin() ?>
-                <?= Div::widget()->class('cover-container d-flex w-100 h-100 mx-auto flex-column')->begin() ?>
-                    <?= Header::widget()->class('mb-auto')->begin() ?>
-                        <?= $this->render('component/menu') ?>
-                        <?= $this->render('component/alert') ?>
-                        <?= Breadcrumbs::widget(
-                            [
-                                'links' => $this->params['breadcrumbs'] ?? [],
-                            ]
-                        ) ?>
-                    <?= Header::end() ?>
-                    <?= $content ?>
-                    <?= $this->render('footer') ?>
-                <?= Div::end() ?>
-                <?= Icon::symbols($this) ?>
-            <?= Body::end() ?>
-        <?php $this->endBody() ?>
-    <?= Html::end() ?>
+<?php $this->beginPage() ?><!DOCTYPE html>
+<?= Html::widget()->attributes(['lang' => Yii::$app->language, 'data-bs-theme' => 'auto'])->begin() ?>
+<?= $this->render('head') ?>
+<?php $this->beginBody() ?>
+<?= Body::widget()->class('d-flex')->begin() ?>
+<?= Div::widget()->class('cover-container d-flex w-100 h-100 mx-auto flex-column')->begin() ?>
+<?= Header::widget()->class('mb-auto')->begin() ?>
+<?= $this->render('component/menu') ?>
+<?= $this->render('component/alert') ?>
+<?= Breadcrumbs::widget(
+    [
+        'links' => $this->params['breadcrumbs'] ?? [],
+    ]
+) ?>
+<?= Header::end() ?>
+<?= $content ?>
+<?= $this->render('footer') ?>
+<?= Div::end() ?>
+<?= Icon::symbols($this) ?>
+<?= Body::end() ?>
+<?php $this->endBody() ?>
+<?= Html::end() ?>
 <?php $this->endPage();
diff --git a/yii.bat b/yii.bat
@@ -5,7 +5,7 @@ rem  Yii command line bootstrap script for Windows.
 rem
 rem  @author Qiang Xue <[email protected]>
 rem  @link https://www.yiiframework.com/
-rem  @copyright Copyright (c) 2008 Yii Software LLC
+rem  @copyright Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
 rem  @license https://www.yiiframework.com/license/
 rem -------------------------------------------------------------