Coder Social home page Coder Social logo

mpociot / documentarian Goto Github PK

View Code? Open in Web Editor NEW
380.0 8.0 90.0 417 KB

Create beautiful API documentation

Home Page: http://marcelpociot.de/documentarian/installation

License: Other

PHP 7.10% JavaScript 67.64% CSS 5.57% HTML 7.95% Stylus 10.48% Blade 1.27%

documentarian's Introduction

Documentarian

Simply write beautiful API documentation.

========

image image codecov.io Scrutinizer Code Quality Build Status

This project is a PHP port of the popular Slate API documentation tool.

If PHP is not your thing and you're more into nodeJS, why not give Whiteboard a try?

Documentarian

Check out a Documentarian example API documentation.

The documentation is available at http://marcelpociot.com/documentarian/installation

Slate / Whiteboard compatibility

Since both Documentarian and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please submit an issue.

In depth documentation

For further documentation, read the documentation.

Documentations built with Documentarian

Feel free to submit a PR with a link to your documentation.

Contributors

Slate was built by Robert Lord while at TripIt.

Documentarian was built by Marcel Pociot.

documentarian's People

Contributors

ecointest avatar jleonardolemos avatar mpociot avatar pashamesh avatar tpobozy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentarian's Issues

apidoc:generate command not found

I followed all your instructions to install if for Lumen (V7) but when I tried to run apidoc:generate it's giving me: command not found error.

installing suggestions

Hi, i have this errors:

windwalker/renderer suggests installing league/plates (Install 3.* if you require Plates template engine.)
windwalker/renderer suggests installing twig/twig (Install 1.* if you require Twig engine.)
windwalker/renderer suggests installing mustache/mustache (Install 2.* if you require Mustache engine.)
paragonie/random_compat suggests installing ext-libsodium (Provides a modern crypto API that can be used to generate random bytes.)
illuminate/support suggests installing symfony/process (Required to use the composer class (3.1.).)
illuminate/support suggests installing symfony/var-dumper (Required to use the dd function (3.1.
).)
illuminate/filesystem suggests installing league/flysystem (Required to use the Flysystem local and FTP drivers (~1.0).)
illuminate/filesystem suggests installing league/flysystem-aws-s3-v3 (Required to use the Flysystem S3 driver (~1.0).)
illuminate/filesystem suggests installing league/flysystem-rackspace (Required to use the Flysystem Rackspace driver (~1.0).)
symfony/console suggests installing symfony/event-dispatcher ()
symfony/console suggests installing symfony/process ()

Table markdown support?

I'm a little confused by the documentation, does this support the table syntax or not.

The documentation mentions the table syntax, but it is contained within the body of the 'code sample' example so it's not clear if this indicates support or just (slightly confusing) example text. A quick test seemed to suggest it does not support it - but I just wanted to be sure.

http://marcelpociot.com/documentarian/installation/markdown_syntax

rules exists:table,id check value for example

rule:
'collection_country_id' => 'integer|exists:countries,id',

documentation row:
collection_country_id integer optional Valid country id

example request:
-d "collection_country_id"="4166" \

i dont have country id = 4166

Logo is blurry in HiDPI displays

The logo as instructed by the documentation must be 230x52. However, to remedy blurriness on HiDPI displays, I use 2x (460x104). Since the img tag does not use fixed width and height, my logo overflows the sidebar. To remedy this, I added a fixed width and height to the tag in PR #29.

Update 1: I noticed an older PR from last year, #17 which has not yet been pulled but addresses the same concern. Any solution will do. Strange that @mpociot hasn't pulled #17 even if the repo and owner are still active.

Update 2: Tried replicating PR #17 but it doesn't work anymore, it should be closed @mpociot. PR #29 is more current and compliant with HTML standards anyway.

Links hijacked on documentation site?

Hi there, was taking a look at the docs site for this project and I clicked the Example Documentation link on the home page which resulted in a bunch of forwards. It ends up asking to install flash with different sketchy domains each time.

The link is on this page:

screen shot 2019-02-26 at 10 06 27 pm

Scrolling Issue

First of all, I am not sure, if it is a bug with this package, another one or if it is intentional..
If you take a look at your demo site
make the browser fullscreen and then click at the last entry (e.g., Errors)

Then the page jumps to the bottom of the page, BUT
the menu on the left opens the "second last" entry (e.g., Kittens).

I know, this is mainly because of the scroll-plugin, which - I assume - checks the respective position of the viewport. If you make the browser-window quite small in height and click again on Errors the menu highlights the correct entry.

I guess, this is not a bug from this package, but it feels wrong ;)

Composer instable set of packages

When i tried to install this with composer, using composer global require mpociot/documentatian i get an error that there is a instable set of packages.

I run php 7.1.1

Full output:

Using version ^0.2.1 for mpociot/documentarian
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Conclusion: remove illuminate/container v5.3.23
    - Conclusion: don't install illuminate/container v5.3.23
    - illuminate/view v5.1.1 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.13 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.16 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.2 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.20 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.22 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.25 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.28 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.30 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.31 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.41 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.6 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.1.8 requires illuminate/container 5.1.* -> satisfiable by illuminate/container[v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8].
    - illuminate/view v5.2.0 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.19 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.21 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.24 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.25 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.26 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.27 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.28 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.31 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.32 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.37 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.43 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.45 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.6 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.2.7 requires illuminate/container 5.2.* -> satisfiable by illuminate/container[v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7].
    - illuminate/view v5.4.0 requires illuminate/container 5.4.* -> satisfiable by illuminate/container[v5.4.0, v5.4.13, v5.4.9].
    - illuminate/view v5.4.13 requires illuminate/container 5.4.* -> satisfiable by illuminate/container[v5.4.0, v5.4.13, v5.4.9].
    - illuminate/view v5.4.9 requires illuminate/container 5.4.* -> satisfiable by illuminate/container[v5.4.0, v5.4.13, v5.4.9].
    - illuminate/view v5.0.0 requires illuminate/container 5.0.* -> satisfiable by illuminate/container[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4].
    - illuminate/view v5.0.22 requires illuminate/container 5.0.* -> satisfiable by illuminate/container[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4].
    - illuminate/view v5.0.25 requires illuminate/container 5.0.* -> satisfiable by illuminate/container[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4].
    - illuminate/view v5.0.26 requires illuminate/container 5.0.* -> satisfiable by illuminate/container[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4].
    - illuminate/view v5.0.28 requires illuminate/container 5.0.* -> satisfiable by illuminate/container[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4].
    - illuminate/view v5.0.33 requires illuminate/container 5.0.* -> satisfiable by illuminate/container[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4].
    - illuminate/view v5.0.4 requires illuminate/container 5.0.* -> satisfiable by illuminate/container[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4].
    - Can only install one of: illuminate/container[v5.1.1, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.13, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.16, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.2, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.20, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.22, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.25, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.28, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.30, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.31, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.41, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.6, v5.3.23].
    - Can only install one of: illuminate/container[v5.1.8, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.0, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.19, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.21, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.24, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.25, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.26, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.27, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.28, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.31, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.32, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.37, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.43, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.45, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.6, v5.3.23].
    - Can only install one of: illuminate/container[v5.2.7, v5.3.23].
    - Can only install one of: illuminate/container[v5.4.0, v5.3.23].
    - Can only install one of: illuminate/container[v5.4.13, v5.3.23].
    - Can only install one of: illuminate/container[v5.4.9, v5.3.23].
    - Can only install one of: illuminate/container[v5.0.0, v5.3.23].
    - Can only install one of: illuminate/container[v5.0.22, v5.3.23].
    - Can only install one of: illuminate/container[v5.0.25, v5.3.23].
    - Can only install one of: illuminate/container[v5.0.26, v5.3.23].
    - Can only install one of: illuminate/container[v5.0.28, v5.3.23].
    - Can only install one of: illuminate/container[v5.0.33, v5.3.23].
    - Can only install one of: illuminate/container[v5.0.4, v5.3.23].
    - Installation request for illuminate/container (locked at v5.3.23) -> satisfiable by illuminate/container[v5.3.23].
    - Installation request for mpociot/documentarian ^0.2.1 -> satisfiable by mpociot/documentarian[0.2.1].
    - Conclusion: don't install symfony/debug v3.2.1|install illuminate/view v5.0.0|install illuminate/view v5.0.22|install illuminate/view v5.0.25|install illuminate/view v5.0.26|install illuminate/view v5.0.28|install illuminate/view v5.0.33|install illuminate/view v5.0.4|install illuminate/view v5.1.1|install illuminate/view v5.1.13|install illuminate/view v5.1.16|install illuminate/view v5.1.2|install illuminate/view v5.1.20|install illuminate/view v5.1.22|install illuminate/view v5.1.25|install illuminate/view v5.1.28|install illuminate/view v5.1.30|install illuminate/view v5.1.31|install illuminate/view v5.1.41|install illuminate/view v5.1.6|install illuminate/view v5.1.8|install illuminate/view v5.2.0|install illuminate/view v5.2.19|install illuminate/view v5.2.21|install illuminate/view v5.2.24|install illuminate/view v5.2.25|install illuminate/view v5.2.26|install illuminate/view v5.2.27|install illuminate/view v5.2.28|install illuminate/view v5.2.31|install illuminate/view v5.2.32|install illuminate/view v5.2.37|install illuminate/view v5.2.43|install illuminate/view v5.2.45|install illuminate/view v5.2.6|install illuminate/view v5.2.7|install illuminate/view v5.4.0|install illuminate/view v5.4.13|install illuminate/view v5.4.9
    - Conclusion: remove symfony/debug v3.2.1|install illuminate/view v5.0.0|install illuminate/view v5.0.22|install illuminate/view v5.0.25|install illuminate/view v5.0.26|install illuminate/view v5.0.28|install illuminate/view v5.0.33|install illuminate/view v5.0.4|install illuminate/view v5.1.1|install illuminate/view v5.1.13|install illuminate/view v5.1.16|install illuminate/view v5.1.2|install illuminate/view v5.1.20|install illuminate/view v5.1.22|install illuminate/view v5.1.25|install illuminate/view v5.1.28|install illuminate/view v5.1.30|install illuminate/view v5.1.31|install illuminate/view v5.1.41|install illuminate/view v5.1.6|install illuminate/view v5.1.8|install illuminate/view v5.2.0|install illuminate/view v5.2.19|install illuminate/view v5.2.21|install illuminate/view v5.2.24|install illuminate/view v5.2.25|install illuminate/view v5.2.26|install illuminate/view v5.2.27|install illuminate/view v5.2.28|install illuminate/view v5.2.31|install illuminate/view v5.2.32|install illuminate/view v5.2.37|install illuminate/view v5.2.43|install illuminate/view v5.2.45|install illuminate/view v5.2.6|install illuminate/view v5.2.7|install illuminate/view v5.4.0|install illuminate/view v5.4.13|install illuminate/view v5.4.9
    - mpociot/documentarian 0.2.1 requires illuminate/view 5.* -> satisfiable by illuminate/view[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4, v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.28, v5.1.30, v5.1.31, v5.1.41, v5.1.6, v5.1.8, v5.2.0, v5.2.19, v5.2.21, v5.2.24, v5.2.25, v5.2.26, v5.2.27, v5.2.28, v5.2.31, v5.2.32, v5.2.37, v5.2.43, v5.2.45, v5.2.6, v5.2.7, v5.3.0, v5.3.16, v5.3.23, v5.3.4, v5.4.0, v5.4.13, v5.4.9].
    - illuminate/view v5.3.0 requires symfony/debug 3.1.* -> satisfiable by symfony/debug[v3.1.0, v3.1.1, v3.1.10, v3.1.2, v3.1.3, v3.1.4, v3.1.5, v3.1.6, v3.1.7, v3.1.8, v3.1.9].
    - illuminate/view v5.3.16 requires symfony/debug 3.1.* -> satisfiable by symfony/debug[v3.1.0, v3.1.1, v3.1.10, v3.1.2, v3.1.3, v3.1.4, v3.1.5, v3.1.6, v3.1.7, v3.1.8, v3.1.9].
    - illuminate/view v5.3.23 requires symfony/debug 3.1.* -> satisfiable by symfony/debug[v3.1.0, v3.1.1, v3.1.10, v3.1.2, v3.1.3, v3.1.4, v3.1.5, v3.1.6, v3.1.7, v3.1.8, v3.1.9].
    - illuminate/view v5.3.4 requires symfony/debug 3.1.* -> satisfiable by symfony/debug[v3.1.0, v3.1.1, v3.1.10, v3.1.2, v3.1.3, v3.1.4, v3.1.5, v3.1.6, v3.1.7, v3.1.8, v3.1.9].
    - Can only install one of: symfony/debug[v3.1.0, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.1, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.10, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.2, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.3, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.4, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.5, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.6, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.7, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.8, v3.2.1].
    - Can only install one of: symfony/debug[v3.1.9, v3.2.1].
    - Installation request for symfony/debug (locked at v3.2.1) -> satisfiable by symfony/debug[v3.2.1].


Installation failed, reverting ./composer.json to its original content.

Customize index.blade.php ?

Hi, it's a nice tool but I think it will be a good thing to "vendor publish" the src/resources/views/index.blade.php in the source directory for many reasons (in my case, i can't set a favicon for my documentation)

by changing [line 81 in src/Documentarian.php]

(https://github.com/mpociot/documentarian/blob/master/src/Documentarian.php#L81) from

$renderer = new BladeRenderer([__DIR__ . '/../resources/views'], ['cache_path' => $source_dir . '/_tmp']);

to this :

$renderer = new BladeRenderer([$source_dir . '/views'], ['cache_path' => $source_dir . '/_tmp']);

Support Chinese #flag

The Chinese I use. When use laravel-apidoc-generator generate apidoc, the Chinese flag will be ignored . Caused by the following code:

function slugify(text){
    return text.toString().toLowerCase()
        .replace(/\s+/g, '-')           // Replace spaces with -
        .replace(/[^\w\-]+/g, '')       // Remove all non-word chars
        .replace(/\-\-+/g, '-')         // Replace multiple - with single -
        .replace(/^-+/, '')             // Trim - from start of text
        .replace(/-+$/, '');            // Trim - from end of text
  }

Can you support Chinese flag?

Language tabs change bash to cURL visually

According to the documentarian documentation for language tabs, I should be able to do something like this in my index.md file:

language_tabs:
  - shell: cURL
  - php
  - php: SDK

However, when running, php artisan apidoc:generate, I get:

In helpers.php line 564:
                                                                                                                                                                            
  htmlspecialchars() expects parameter 1 to be string, array given (View: /home/project/vendor/mpociot/documentarian/resources/views/index.blade.php)

Here is the reference back to my original issue for laravel-apidoc-generator: mpociot/laravel-apidoc-generator#459 (comment)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.