Skip to content

Commit

Permalink
fix read me
Browse files Browse the repository at this point in the history
  • Loading branch information
oxycoder committed Apr 29, 2018
1 parent 8c5c9ef commit 1038863
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 14 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Automatically generate your API documentation from your existing Laravel routes.
Require this package with composer using the following command:

```sh
$ composer require mpociot/laravel-apidoc-generator
$ composer require oxycoder/laravel-apidoc-generator
```
Using Laravel < 5.5? Go to your `config/app.php` and add the service provider:

```php
Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class,
Oxycoder\ApiDoc\ApiDocGeneratorServiceProvider::class,
```

> Using Laravel < 5.4? Use version 1.0! For Laravel 5.4 and up, use 2.0 instead.
Expand Down Expand Up @@ -65,15 +65,15 @@ Option | Description
`force` | Force the re-generation of existing/modified API routes
`header` | Custom HTTP headers to add to the example requests. Separate the header name and value with ":". For example: `--header="Authorization: CustomToken"`

## Publish rule descriptions for customisation or translation.
## Customisation or translation.

By default, this package returns the descriptions in english. You can publish the packages language files, to customise and translate the documentation output.

```sh
$ php artisan vendor:publish
```

After the files are published you can customise or translate the descriptions in the language you want by renaming the `en` folder and editing the files in `public/vendor/apidoc/resources/lang`.
After the files are published you can customise view, styles or translate the descriptions in the language you want by renaming the `en` folder and editing the files in `public/vendor/apidoc/resources/lang`.


### How does it work?
Expand Down Expand Up @@ -235,10 +235,6 @@ As an optional parameter, you can use `--location` to tell the update command wh

If you want to skip a single route from a list of routes that match a given prefix, you can use the `@hideFromAPIDocumentation` tag on the Controller method you do not want to document.

## Further modification

This package uses [Documentarian](https://github.com/mpociot/documentarian) to generate the API documentation. If you want to modify the CSS files of your documentation, or simply want to learn more about what is possible, take a look at the [Documentarian guide](http://marcelpociot.de/documentarian/installation).

### License

The Laravel API Documentation Generator is free software licensed under the MIT license.
3 changes: 1 addition & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
"homepage": "http://github.com/oxycoder/laravel-apidoc-generator",
"authors": [
{
"name": "Tung",
"email": "[email protected]"
"name": "Tung"
}
],
"require": {
Expand Down
8 changes: 4 additions & 4 deletions src/resources/views/index.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>{{$page['title']}}</title>

<link rel="stylesheet" href="css/style.css" />
<script src="js/all.js"></script>
<link rel="stylesheet" href="/docs/css/style.css" />
<script src="/docs/js/all.js"></script>


@if(isset($page['language_tabs']))
Expand All @@ -23,11 +23,11 @@
<a href="#" id="nav-button">
<span>
NAV
<img src="images/navbar.png" />
<img src="/docs/images/navbar.png" />
</span>
</a>
<div class="tocify-wrapper">
<img src="images/logo.png" />
<img src="/docs/images/logo.png" />
@if(isset($page['language_tabs']))
<div class="lang-selector">
@foreach($page['language_tabs'] as $lang)
Expand Down

0 comments on commit 1038863

Please sign in to comment.