Skip to content

Commit 1038863

Browse files
committed
fix read me
1 parent 8c5c9ef commit 1038863

File tree

3 files changed

+9
-14
lines changed

3 files changed

+9
-14
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ Automatically generate your API documentation from your existing Laravel routes.
1818
Require this package with composer using the following command:
1919

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

2525
```php
26-
Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class,
26+
Oxycoder\ApiDoc\ApiDocGeneratorServiceProvider::class,
2727
```
2828

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

68-
## Publish rule descriptions for customisation or translation.
68+
## Customisation or translation.
6969

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

7272
```sh
7373
$ php artisan vendor:publish
7474
```
7575

76-
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`.
76+
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`.
7777

7878

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

236236
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.
237237

238-
## Further modification
239-
240-
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).
241-
242238
### License
243239

244240
The Laravel API Documentation Generator is free software licensed under the MIT license.

composer.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
"homepage": "http://github.com/oxycoder/laravel-apidoc-generator",
1111
"authors": [
1212
{
13-
"name": "Tung",
14-
"email": "[email protected]"
13+
"name": "Tung"
1514
}
1615
],
1716
"require": {

src/resources/views/index.blade.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
77
<title>{{$page['title']}}</title>
88

9-
<link rel="stylesheet" href="css/style.css" />
10-
<script src="js/all.js"></script>
9+
<link rel="stylesheet" href="/docs/css/style.css" />
10+
<script src="/docs/js/all.js"></script>
1111

1212

1313
@if(isset($page['language_tabs']))
@@ -23,11 +23,11 @@
2323
<a href="#" id="nav-button">
2424
<span>
2525
NAV
26-
<img src="images/navbar.png" />
26+
<img src="/docs/images/navbar.png" />
2727
</span>
2828
</a>
2929
<div class="tocify-wrapper">
30-
<img src="images/logo.png" />
30+
<img src="/docs/images/logo.png" />
3131
@if(isset($page['language_tabs']))
3232
<div class="lang-selector">
3333
@foreach($page['language_tabs'] as $lang)

0 commit comments

Comments
 (0)