Browse Source

Moved docs from the guide, adjusted readme

tags/2.0.4
Alexander Makarov 10 years ago
parent
commit
06e41a8d1f
  1. 2
      README.md
  2. 27
      docs/guide/README.md
  3. 17
      docs/guide/basic-usage.md
  4. 20
      docs/guide/installation.md
  5. 17
      docs/guide/topics-less.md
  6. 19
      docs/guide/usage-widgets.md

2
README.md

@ -5,8 +5,6 @@ This is the Twitter Bootstrap extension for Yii 2. It encapsulates [Bootstrap](h
and plugins in terms of Yii widgets, and thus makes using Bootstrap components/plugins and plugins in terms of Yii widgets, and thus makes using Bootstrap components/plugins
in Yii applications extremely easy. in Yii applications extremely easy.
This repository is a git submodule of <https://github.com/yiisoft/yii2>.
Please submit issue reports and pull requests to the main repository.
For license information check the [LICENSE](LICENSE.md)-file. For license information check the [LICENSE](LICENSE.md)-file.
Installation Installation

27
docs/guide/README.md

@ -0,0 +1,27 @@
MongoDb Extension for Yii 2
===========================
Out of the box, Yii includes support for the [Bootstrap 3](http://getbootstrap.com/) markup and components framework
(also known as "Twitter Bootstrap"). Bootstrap is an excellent, responsive framework that can greatly speed up the
client-side of your development process.
The core of Bootstrap is represented by two parts:
- CSS basics, such as a grid layout system, typography, helper classes, and responsive utilities.
- Ready to use components, such as forms, menus, pagination, modal boxes, tabs etc.
Getting Started
---------------
* [Installation](installation.md)
* [Basic Usage](basic-usage.md)
Usage
-----
* [Yii widgets](usage-widgets.md)
Additional topics
-----------------
* [Using the .less files of Bootstrap directly](topics-less.md)

17
docs/guide/basic-usage.md

@ -0,0 +1,17 @@
Basic Usage
===========
Yii doesn't wrap the bootstrap basics into PHP code since HTML is very simple by itself in this case. You can find details
about using the basics at [bootstrap documentation website](http://getbootstrap.com/css/). Still Yii provides a
convenient way to include bootstrap assets in your pages with a single line added to `AppAsset.php` located in your
`@app/assets` directory:
```php
public $depends = [
'yii\web\YiiAsset',
'yii\bootstrap\BootstrapAsset', // this line
];
```
Using bootstrap through Yii asset manager allows you to minimize its resources and combine with your own resources when
needed.

20
docs/guide/installation.md

@ -0,0 +1,20 @@
Installation
============
## Getting Composer package
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yiisoft/yii2-bootstrap
```
or add
```
"yiisoft/yii2-bootstrap": "~2.0.0"
```
to the require section of your `composer.json` file.

17
docs/guide/topics-less.md

@ -0,0 +1,17 @@
Using the .less files of Bootstrap directly
===========================================
If you want to include the [Bootstrap css directly in your less files](http://getbootstrap.com/getting-started/#customizing)
you may need to disable the original bootstrap css files to be loaded.
You can do this by setting the css property of the [[yii\bootstrap\BootstrapAsset|BootstrapAsset]] to be empty.
For this you need to configure the `assetManager` [application component](structure-application-components.md) as follows:
```php
'assetManager' => [
'bundles' => [
'yii\bootstrap\BootstrapAsset' => [
'css' => [],
]
]
]
```

19
docs/guide/usage-widgets.md

@ -0,0 +1,19 @@
Yii widgets
===========
Most complex bootstrap components are wrapped into Yii widgets to allow more robust syntax and integrate with
framework features. All widgets belong to `\yii\bootstrap` namespace:
- [[yii\bootstrap\ActiveForm|ActiveForm]]
- [[yii\bootstrap\Alert|Alert]]
- [[yii\bootstrap\Button|Button]]
- [[yii\bootstrap\ButtonDropdown|ButtonDropdown]]
- [[yii\bootstrap\ButtonGroup|ButtonGroup]]
- [[yii\bootstrap\Carousel|Carousel]]
- [[yii\bootstrap\Collapse|Collapse]]
- [[yii\bootstrap\Dropdown|Dropdown]]
- [[yii\bootstrap\Modal|Modal]]
- [[yii\bootstrap\Nav|Nav]]
- [[yii\bootstrap\NavBar|NavBar]]
- [[yii\bootstrap\Progress|Progress]]
- [[yii\bootstrap\Tabs|Tabs]]
Loading…
Cancel
Save