Skip to content

Commit

Permalink
Merge branch 'release/2.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
reliq committed Mar 23, 2019
2 parents 3fdc21e + 8ade3d9 commit 2574b5b
Show file tree
Hide file tree
Showing 60 changed files with 276 additions and 275 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Docweaver is suitable for product documentation and/or knowledge bases. Converts
[![CircleCI (all branches)](https://img.shields.io/circleci/project/github/reliqarts/laravel-docweaver/master.svg?style=flat-square)](https://circleci.com/gh/reliqarts/laravel-docweaver/tree/master)
[![Scrutinizer](https://img.shields.io/scrutinizer/g/reliqarts/laravel-docweaver.svg?style=flat-square)](https://scrutinizer-ci.com/g/reliqarts/laravel-docweaver/)
[![Codecov](https://img.shields.io/codecov/c/github/reliqarts/laravel-docweaver.svg?style=flat-square)](https://codecov.io/gh/reliqarts/laravel-docweaver)
[![License](https://poser.pugx.org/reliqarts/docweaver/license?format=flat-square)](https://packagist.org/packages/reliqarts/docweaver)
[![Latest Stable Version](https://poser.pugx.org/reliqarts/docweaver/version?format=flat-square)](https://packagist.org/packages/reliqarts/docweaver)
[![Latest Unstable Version](https://poser.pugx.org/reliqarts/docweaver/v/unstable?format=flat-square)](//packagist.org/packages/reliqarts/docweaver)
[![License](https://poser.pugx.org/reliqarts/laravel-docweaver/license?format=flat-square)](https://packagist.org/packages/reliqarts/laravel-docweaver)
[![Latest Stable Version](https://poser.pugx.org/reliqarts/laravel-docweaver/version?format=flat-square)](https://packagist.org/packages/reliqarts/laravel-docweaver)
[![Latest Unstable Version](https://poser.pugx.org/reliqarts/laravel-docweaver/v/unstable?format=flat-square)](//packagist.org/packages/reliqarts/laravel-docweaver)
[![check it out!](https://img.shields.io/badge/read-the%20docs-blue.svg?style=flat-square)](http://docweaver.reliqarts.com)

 
Expand All @@ -30,13 +30,13 @@ Docweaver provides the following features and more out of the box.

Install via composer; in console:
```
composer require reliqarts/docweaver
composer require reliqarts/laravel-docweaver
```
or require in *composer.json*:
```json
{
"require": {
"reliqarts/docweaver": "^2.0"
"reliqarts/laravel-docweaver": "^2.0"
}
}
```
Expand All @@ -46,7 +46,7 @@ Once this has finished, you will need to add the service provider to the provide
*(n.b. This package supports Laravel's package auto-discovery; if you are using Laravel 5.5 or above you can skip this step.)*

```php
ReliQArts\Docweaver\DocweaverServiceProvider::class,
ReliqArts\Docweaver\ServiceProvider::class,
```

Ensure that your applications public storage directory is linked and accessible via the browser.
Expand All @@ -59,13 +59,13 @@ see: https://laravel.com/docs/master/filesystem
Finally, publish package resources and configuration:

```
php artisan vendor:publish --provider="ReliQArts\Docweaver\DocweaverServiceProvider"
php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider"
```

You may opt to publish only configuration by using the `docweaver:config` tag:
You may opt to publish only configuration by using the `docweaver-config` tag:

```
php artisan vendor:publish --provider="ReliQArts\Docweaver\DocweaverServiceProvider" --tag="docweaver:config"
php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider" --tag="docweaver-config"
```

### Setup
Expand All @@ -78,7 +78,7 @@ DOCWEAVER_ROUTE_PREFIX=docs
DOCWEAVER_DIR=resources/docs
```

These variables, and more are explained within the [config](https://github.com/ReliQArts/laravel-docweaver/blob/master/src/config/config.php) file.
These variables, and more are explained within the [config](https://github.com/ReliqArts/laravel-docweaver/blob/master/src/config/config.php) file.

### Documentation Directory

Expand Down
23 changes: 12 additions & 11 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "reliqarts/docweaver",
"name": "reliqarts/laravel-docweaver",
"description": "Highly configurable Laravel 5.x package for product documentation.",
"keywords": [
"doc",
Expand All @@ -18,7 +18,8 @@
}
],
"replace": {
"reliqarts/doc-weaver": "1.*"
"reliqarts/doc-weaver": "1.*",
"reliqarts/docweaver": "*"
},
"require": {
"php": ">=7.1.3",
Expand All @@ -35,26 +36,26 @@
"require-dev": {
"phpunit/phpunit": "~7.0",
"orchestra/testbench-browser-kit": "~3.1",
"goaop/framework":"2.2.0",
"goaop/framework": "2.2.0",
"codeception/aspect-mock": "^3.0"
},
"autoload": {
"psr-4": {
"ReliQArts\\Docweaver\\": "src/",
"ReliQArts\\Docweaver\\Tests\\": "tests/"
"ReliqArts\\Docweaver\\": "src/",
"ReliqArts\\Docweaver\\Tests\\": "tests/"
}
},
"extra": {
"laravel": {
"providers": [
"ReliQArts\\Docweaver\\ServiceProvider"
"ReliqArts\\Docweaver\\ServiceProvider"
],
"aliases": {
"DocweaverConfig": "ReliQArts\\Docweaver\\Helpers\\Config",
"DocweaverDocumentation": "ReliQArts\\Docweaver\\Models\\Documentation",
"DocweaverMarkdown": "ReliQArts\\Docweaver\\Helpers\\Markdown",
"DocweaverProduct": "ReliQArts\\Docweaver\\Models\\Product",
"DocweaverPublisher": "ReliQArts\\Docweaver\\Services\\Publisher"
"DocweaverConfig": "ReliqArts\\Docweaver\\Helpers\\Config",
"DocweaverDocumentation": "ReliqArts\\Docweaver\\Models\\Documentation",
"DocweaverMarkdown": "ReliqArts\\Docweaver\\Helpers\\Markdown",
"DocweaverProduct": "ReliqArts\\Docweaver\\Models\\Product",
"DocweaverPublisher": "ReliqArts\\Docweaver\\Services\\Publisher"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions resources/js/docweaver.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ require('./vendor/prism.js');
// import core
import Docweaver from './modules/core';

$(function() {
$(function () {
// start
new Docweaver;
});
});
2 changes: 1 addition & 1 deletion resources/views/index.blade.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@php
/**
* @var \ReliQArts\Docweaver\Services\ConfigProvider $docweaverConfigProvider
* @var \ReliqArts\Docweaver\Services\ConfigProvider $docweaverConfigProvider
*/
$templateConfig = $docweaverConfigProvider->getTemplateConfig();
@endphp
Expand Down
2 changes: 1 addition & 1 deletion resources/views/layout.blade.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@php
/**
* @var \ReliQArts\Docweaver\Services\ConfigProvider $docweaverConfigProvider
* @var \ReliqArts\Docweaver\Services\ConfigProvider $docweaverConfigProvider
*/
$templateConfig = $docweaverConfigProvider->getTemplateConfig();
$scripts = '<script type="text/javascript" src="/vendor/docweaver/js/docweaver.js"></script>';
Expand Down
4 changes: 2 additions & 2 deletions routes/web.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
declare(strict_types=1);

use Illuminate\Support\Facades\Route;
use ReliQArts\Docweaver\Contracts\ConfigProvider;
use ReliqArts\Docweaver\Contracts\ConfigProvider;

/**
* @var ConfigProvider
*/
$configProvider = resolve(ConfigProvider::class);

// Controller Fully Qualified...
$docController = 'ReliQArts\\Docweaver\\Http\\Controllers\\DocumentationController';
$docController = 'ReliqArts\\Docweaver\\Http\\Controllers\\DocumentationController';

// the route group
Route::group($configProvider->getRouteGroupBindings(), function () use ($configProvider, $docController) {
Expand Down
6 changes: 3 additions & 3 deletions src/Console/Commands/Publish.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Console\Commands;
namespace ReliqArts\Docweaver\Console\Commands;

use Carbon\Carbon;
use Illuminate\Console\Command;
use ReliQArts\Docweaver\Contracts\Documentation\Publisher;
use ReliQArts\Docweaver\Exceptions\InvalidDirectory;
use ReliqArts\Docweaver\Contracts\Documentation\Publisher;
use ReliqArts\Docweaver\Exceptions\InvalidDirectory;

class Publish extends Command
{
Expand Down
4 changes: 2 additions & 2 deletions src/Console/Commands/Update.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Console\Commands;
namespace ReliqArts\Docweaver\Console\Commands;

use Carbon\Carbon;
use Illuminate\Console\Command;
use ReliQArts\Docweaver\Contracts\Documentation\Publisher;
use ReliqArts\Docweaver\Contracts\Documentation\Publisher;

class Update extends Command
{
Expand Down
4 changes: 2 additions & 2 deletions src/Console/Commands/UpdateAll.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Console\Commands;
namespace ReliqArts\Docweaver\Console\Commands;

use Carbon\Carbon;
use Illuminate\Console\Command;
use ReliQArts\Docweaver\Contracts\Documentation\Publisher;
use ReliqArts\Docweaver\Contracts\Documentation\Publisher;

class UpdateAll extends Command
{
Expand Down
4 changes: 2 additions & 2 deletions src/Contracts/ConfigProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts;
namespace ReliqArts\Docweaver\Contracts;

use ReliQArts\Docweaver\Models\TemplateConfig;
use ReliqArts\Docweaver\Models\TemplateConfig;

interface ConfigProvider
{
Expand Down
4 changes: 2 additions & 2 deletions src/Contracts/Documentation/Provider.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts\Documentation;
namespace ReliqArts\Docweaver\Contracts\Documentation;

use ReliQArts\Docweaver\Models\Product;
use ReliqArts\Docweaver\Models\Product;

interface Provider
{
Expand Down
8 changes: 4 additions & 4 deletions src/Contracts/Documentation/Publisher.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts\Documentation;
namespace ReliqArts\Docweaver\Contracts\Documentation;

use Illuminate\Console\Command;
use ReliQArts\Docweaver\Contracts\Publisher as BasePublisher;
use ReliQArts\Docweaver\Exceptions\InvalidDirectory;
use ReliQArts\Docweaver\VO\Result;
use ReliqArts\Docweaver\Contracts\Publisher as BasePublisher;
use ReliqArts\Docweaver\Exceptions\InvalidDirectory;
use ReliqArts\Docweaver\VO\Result;

interface Publisher extends BasePublisher
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/Exception.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts;
namespace ReliqArts\Docweaver\Contracts;

/**
* Interface Exception.
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/Filesystem.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts;
namespace ReliqArts\Docweaver\Contracts;

interface Filesystem
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/Logger.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts;
namespace ReliqArts\Docweaver\Contracts;

use Psr\Log\LoggerInterface;

Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/MarkdownParser.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts;
namespace ReliqArts\Docweaver\Contracts;

interface MarkdownParser
{
Expand Down
4 changes: 2 additions & 2 deletions src/Contracts/Product/Finder.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts\Product;
namespace ReliqArts\Docweaver\Contracts\Product;

use ReliQArts\Docweaver\Models\Product;
use ReliqArts\Docweaver\Models\Product;

interface Finder
{
Expand Down
6 changes: 3 additions & 3 deletions src/Contracts/Product/Maker.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts\Product;
namespace ReliqArts\Docweaver\Contracts\Product;

use ReliQArts\Docweaver\Contracts\Exception;
use ReliQArts\Docweaver\Models\Product;
use ReliqArts\Docweaver\Contracts\Exception;
use ReliqArts\Docweaver\Models\Product;

interface Maker
{
Expand Down
10 changes: 5 additions & 5 deletions src/Contracts/Product/Publisher.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts\Product;
namespace ReliqArts\Docweaver\Contracts\Product;

use ReliQArts\Docweaver\Contracts\Publisher as BasePublisher;
use ReliQArts\Docweaver\Exceptions\Product\PublicationFailed;
use ReliQArts\Docweaver\Models\Product;
use ReliQArts\Docweaver\VO\Result;
use ReliqArts\Docweaver\Contracts\Publisher as BasePublisher;
use ReliqArts\Docweaver\Exceptions\Product\PublicationFailed;
use ReliqArts\Docweaver\Models\Product;
use ReliqArts\Docweaver\VO\Result;

interface Publisher extends BasePublisher
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/Publisher.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts;
namespace ReliqArts\Docweaver\Contracts;

interface Publisher
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/VCSCommandRunner.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Contracts;
namespace ReliqArts\Docweaver\Contracts;

use Symfony\Component\Process\Exception\ProcessFailedException;

Expand Down
2 changes: 1 addition & 1 deletion src/Exceptions/BadImplementation.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Exceptions;
namespace ReliqArts\Docweaver\Exceptions;

/**
* {@inheritdoc}
Expand Down
4 changes: 2 additions & 2 deletions src/Exceptions/Exception.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Exceptions;
namespace ReliqArts\Docweaver\Exceptions;

use Exception as BaseException;
use ReliQArts\Docweaver\Contracts\Exception as ExceptionContract;
use ReliqArts\Docweaver\Contracts\Exception as ExceptionContract;

abstract class Exception extends BaseException implements ExceptionContract
{
Expand Down
4 changes: 2 additions & 2 deletions src/Exceptions/InvalidDirectory.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Exceptions;
namespace ReliqArts\Docweaver\Exceptions;

use ReliQArts\Docweaver\Contracts\Exception as ExceptionContract;
use ReliqArts\Docweaver\Contracts\Exception as ExceptionContract;

class InvalidDirectory extends Exception
{
Expand Down
4 changes: 2 additions & 2 deletions src/Exceptions/ParsingFailed.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

declare(strict_types=1);

namespace ReliQArts\Docweaver\Exceptions;
namespace ReliqArts\Docweaver\Exceptions;

use ReliQArts\Docweaver\Contracts\Exception as ExceptionContract;
use ReliqArts\Docweaver\Contracts\Exception as ExceptionContract;

final class ParsingFailed extends Exception
{
Expand Down

0 comments on commit 2574b5b

Please sign in to comment.