Skip to content

docs: add code block language for fix website #523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 15, 2022
Merged

docs: add code block language for fix website #523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcb6d3c
docs: fix code block languages
datamweb Nov 12, 2022
fd0d446
docs: add code block language for install command
datamweb Nov 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,9 @@ Usage of Shield requires the following:
### Installation

Installation is done through Composer.

> composer require codeigniter4/shield
```console
composer require codeigniter4/shield
```

See the [docs](docs/index.md) for more specific instructions on installation and usage recommendations.

Expand Down
22 changes: 11 additions & 11 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ These instructions assume that you have already [installed the CodeIgniter 4 app
Installation is done through [Composer](https://getcomposer.org). The example assumes you have it installed globally.
If you have it installed as a phar, or otherwise you will need to adjust the way you call composer itself.

```
> composer require codeigniter4/shield
```console
Copy link
Member

@MGatner MGatner Nov 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shell

composer require codeigniter4/shield
```

### Troubleshooting
Expand All @@ -35,29 +35,29 @@ If you have it installed as a phar, or otherwise you will need to adjust the way

If you get the following error:

```
Could not find a version of package codeigniter4/shield matching your minimum-stability (stable).
Require it with an explicit version constraint allowing its desired stability.
```console
Could not find a version of package codeigniter4/shield matching your minimum-stability (stable).
Require it with an explicit version constraint allowing its desired stability.
```

1. Add the following to change your [minimum-stability](https://getcomposer.org/doc/articles/versions.md#minimum-stability) in your project `composer.json`:

```json
"minimum-stability": "dev",
"prefer-stable": true,
"minimum-stability": "dev",
"prefer-stable": true,
```

2. Or specify an explicit version:

```console
Copy link
Member

@MGatner MGatner Nov 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shell

> composer require codeigniter4/shield:dev-develop
composer require codeigniter4/shield:dev-develop
```

The above specifies `develop` branch.
See https://getcomposer.org/doc/articles/versions.md#branches

```console
Copy link
Member

@MGatner MGatner Nov 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shell

> composer require codeigniter4/shield:^1.0.0-beta
composer require codeigniter4/shield:^1.0.0-beta
```

The above specifies `v1.0.0-beta` or later and before `v2.0.0`.
Expand All @@ -70,7 +70,7 @@ If you get the following error:
1. Run the following command. This command handles steps 1-5 of *Manual Setup* and runs the migrations.

```console
Copy link
Member

@MGatner MGatner Nov 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shell

> php spark shield:setup
php spark shield:setup
```

### Manual Setup
Expand Down Expand Up @@ -120,7 +120,7 @@ your project.
5. **Migration** Run the migrations.

```console
Copy link
Member

@MGatner MGatner Nov 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shell

> php spark migrate --all
php spark migrate --all
```

#### Note: migration error
Expand Down