Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
neilime authored and github-actions[bot] committed Dec 21, 2023
1 parent 8e17ffe commit 42c8cdc
Show file tree
Hide file tree
Showing 49 changed files with 22,842 additions and 0 deletions.
32 changes: 32 additions & 0 deletions development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_position: 1
---

# Development

## Setup

`PHP_VERSION` is the version of php to use during the development. Example: `8.3`

```sh
make build-php PHP_VERSION
make install PHP_VERSION
```

## Running tests

```sh
make test PHP_VERSION
```

## Fix code linting

```sh
make lint-fix PHP_VERSION
```

## Running CI scripts

```sh
make ci PHP_VERSION
```
48 changes: 48 additions & 0 deletions installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 1
---

# Installation

## Install this library using composer

```bash
composer require neilime/twbs-helper-module
```

## Include Twitter Bootstrap assets

### With **AssetsBundle** module (easy way)

- Install the [AssetsBundle module](https://github.com/neilime/zf-assets-bundle/wiki/Installation)
- Install [Twitter Bootstrap](https://github.com/twbs/bootstrap#quick-start):

```bash
composer require twbs/bootstrap
```

- Edit the application module configuration file `module/Application/config/module.config.php`, adding the configuration fragment below:

```php
return [
//...
'assets_bundle' => [
'assets' => [
'less' => ['@zfRootPath/vendor/twitter/bootstrap/less/bootstrap.less'],
],
],
//...
];
```

- Edit layout file `module/Application/view/layout/layout.phtml`, to render head scripts:

```php
//...
echo $this->headScript();
//...
```

### Manually

- Copy `bootstrap.css` file (available on [Twitter Bootstrap website](https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css)) into your assets folder and add it in your head scripts.
4 changes: 4 additions & 0 deletions usage/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Usage",
"position": 3
}
4 changes: 4 additions & 0 deletions usage/components/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Components",
"position": 4
}
304 changes: 304 additions & 0 deletions usage/components/accordion.mdx

Large diffs are not rendered by default.

Loading

0 comments on commit 42c8cdc

Please sign in to comment.