dniccum / nova-documentation

A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard.
MIT License
37 stars 15 forks source link

After install I get the navigation link but clicking on it just show white space #3

Closed Otienoh closed 5 years ago

Otienoh commented 5 years ago

This has great potential to solve an issue I have, I have followed the installation instructions and published the resources to the config and view as explained, however, I get a blank white page when I click on the link in my nav bar.

Are there extra steps need to get it working (display the documentation)?

tomredhot commented 5 years ago

Same here

jawainc commented 5 years ago

same here

yassir3wad commented 5 years ago

+1

dniccum commented 5 years ago

What version of Nova are you guys using? All of the documentation is loaded via Javascript. With that said, are there any errors in your Javascript development consoles?

I just performed fresh installation with Nova 2.0.7 on Laravel 5.8 without any issues.

yassir3wad commented 5 years ago

Nova 2.0.7 and there is no error in the javascript console

dniccum commented 5 years ago

With in the Laravel resources directory, is there a documentation directory present?

ghost commented 5 years ago

No, there is no documentation directory

dniccum commented 5 years ago

Ok @yassir3wad @jawainc @Otienoh @tomredhot, that is your issue. During the php artisan vendor:publish --provider="Dniccum\NovaDocumentation\ToolServiceProvider" publishing command, this "should" create a directory and pre-populate the directory with 2 files. These two files can be found here

After the installation is complete, your resource directory should look something like this:

dniccum commented 5 years ago

Closing due to lack of activity.

augustusnaz commented 5 years ago

Can anyone help? I'm having the same issue.

dniccum commented 5 years ago

As indicated above, you MUST perform the artisan vendor command to publish all of the necessary assets to get the pages and navigation to appear.

augustusnaz commented 5 years ago

Yeh the home.md and sample.md files are present. It could be a routing problem because

Both the config file and vendor resources are published so not sure where the issue is coming from

dniccum commented 5 years ago

Are you seeing any errors in your JavaScript console?

augustusnaz commented 5 years ago

Nothing at all! I wonder is it's the same thing @Otienoh had

evelynDickinson commented 4 years ago

So, FWIW I'm experiencing the same issue...

Latest and greatest Laravel working swimmingly Followed the install /nova/documentation contains the two .md files Documentation tool icon appears on the nova nav list Clicking it generates a blank page The URL does not change, it remains /admin in my case per my app's config settings No js errors

php artisan route:list | grep doc yields: GET|HEAD nova-vendor/nova-documentation Dniccum\NovaDocumentation\Http\Controllers\NovaDocumentationController@index nova,Dniccum\NovaDocumentation\Http\Middleware\Authorize

Hitting /nova-vendor/nova-documentation yields the home markdown json

I'd really like to use this, any thoughts?

Thank you.

augustusnaz commented 4 years ago

@evelynDickinson, I later saw that it was fine in production. May be something weird with multiple laverel projects in the same dir, or apache in development. See if that's the case with urs.

dniccum commented 4 years ago

After adding a new feature, I updated the version of Laravel Mix that I was developing with. In doing so, caused the plugin to show EXACTLY what you are referencing. To fix this, I updated some of the Javascript syntax. Please try again with the new version to see if this fixes your issue.

evelynDickinson commented 4 years ago

Unfortunately, still no joy. I did an update, and a full remove/require. Same behavior as before.

evelynDickinson commented 4 years ago

I've staged the project to Forge and Nova Documentation is now working fine. It must be something with my local environment. My apologies for the time suck.

dniccum commented 4 years ago

@evelynDickinson No worries at all. I will continue to look into this so I can provide additional direction on how to avoid this in the future. Thank you for the follow up, and thank you for your interest in my plugin.

otrsw commented 3 years ago

For me it seems as if the issue is caused by the "path" in the home.md file is "welcome" and the link generated directs to home. So I am solving by using the direct path /nova/documentation/welcome
Have to take the same approach when adding links in the markdown - so instead of adding the [My page](markdownfile.md) I do [My page](path)