nk-crew / docspress Goto Github PK

Hi Guys.

Love the plugin, still working through setting it up.

Just noticed that you use the word 'Documentations' in the menu item and elsewhere in the code. The plural for 'Documentation' is 'Documentation' - there is no 's' on the end.

Makes much better sense using the word 'Documentation'

Feel free if you need any other help with translating

Keep up the great work.

P.S. you should also change this on your website too ;)

/DM

Hi, I'm loving this plugin, and thanks for building it and making it available.

I'm customizing the CSS to match my theme and I would like to remove the bouncing header and popup article count with this class:

.docspress-archive .docspress-archive-list>.docspress-archive-list-item .docspress-archive-list-item-title>span h2

I can't find any CSS :hover to disable, so wondering if it's JS or jQuery instead?

Would you consider an option to disable animations? Or is there a fix for this I can apply locally?

Thanks.

Related topic: https://wordpress.org/support/topic/loading-the-assets-only-on-the-documentation-pages/

Move to this starter plugin - https://github.com/nk-o/wp-starter-plugin

I get Request failed: [object EventSource] after click on Export button on PHP 8.0 but 7.4 works well.

Wordpress 6 and PHP 8.0.x

[23-Jun-2022 08:49:03 UTC] PHP Deprecated: Required parameter $force_delete follows optional parameter $parent_id in /home/wp-content/plugins/docspress/includes/class-ajax.php on line 298

@nk-o, We use Ghostkit alongside the DocsPress plugin to enable hints, notes and changelog in our documentation, but the styles aren't loaded when the pages are visited via AJAX (which is more common than people directly visiting the changelog URL).

When the page is visited directly, the styles are loaded just fine.

I've recorded a short screencast to explain - https://www.loom.com/share/8aa591d7cd54460093130b92766b97bc

Can this be put on a priority please?

Thanks.

• Using the WP-Editor.md plugin to write a document release, not showing properly

Example:

Normal display in the editor

Request help~

HI

I have been trying to set up site documentation using DocPress but have been unable to get the desired behaviour.

I would like to be able to create a link directly to a document and not have the 'doc' path added to the url.

For example if I create a document called FAQ and then create a menu item that points to the FAQ document I expect the URL to simply be mysite.com/FAQ however what is actually created is mysite.com/[docPressArchivePage]/FAQ.

If I use FAQ as the Archive Page then I end up with mysite.com/FAQ/FAQ which just looks untidy and messy.

Having the top level path included in the URL and breadcrumb also means that users can visit this URL and see other documentation that I do not want to be visible to them. Whilst I am using the 'Groups' plugin to actually control access, it's messy to let visitors see something that they should not be able to access/

How can I achieve what I want?

mysite.com/FAQ that links to docPress document (2 column layout showing file tree)

Whilst still leaving the possibility to use the following URL in my customer support portal (a controlled area)

mysite.com/documentation/product-support-document-1
mysite.com/documentation/product-support-document-2

etc.

At the moment I'm using different document management plugins for each area, I would like to use just one. DocPress nearly does this but for a few small issues.

Looking forwards to your help

/DM

Related issue: nk-crew/ghostkit#48

Hi there!

To adding custom styling would be awesome to have classes to identify every element

For example, actually DocsPress renders elements like this:
li.docspress-archive-list-item
li.docspress-archive-list-category
li.docspress-archive-list-item
li.docspress-archive-list-category
li.docspress-archive-list-item

The idea is to add extra classes like this:
li.docspress-archive-list-item.docspress-archive-list-item-html-template
li.docspress-archive-list-category.docspress-archive-list-category-themes
li.docspress-archive-list-item.docspress-archive-list-item-custom-theme
li.docspress-archive-list-category.docspress-archive-list-category-custom-code
li.docspress-archive-list-item.docspress-archive-list-item-other-docs

So you have the general classes "docspress-archive-list-item" and "docspress-archive-list-category" but also you have the "docspress-archive-list-item-{post-slug}" and "docspress-archive-list-category-{category-slug}" to style specific elements

Hello,
After my fresh install on my WordPress v5.2.4 I face with this issue:

Also, I tried in my local machine using Xampp, the same issue.
Please consider my php version is 7.2

I'm using this plugin as a customer support portal, part of which includes downloadable content. At the moment I'm adding the content inline within the document. Clicking on the document link and then clicking on the download link within the document to download the content (for example PDF documntation)

It would be good to link directly to a URL instead of a document. So that when the link is clicked on it serves the downloadable content.

For example - in the admin interface, when adding a section or an article, we can instead add a link, like this...

Where the there is some kind of shortcode with the URL contained in brackets, for example...

My Link Title [mysite.com/mycontent]

Then on the front end it is displayed like this....

And when the links are clicked on, it takes you to the saved URL.

Simples

I think that this is a simple change but will add great power to your extension as it allows it to be used to serve downloadable documentation and files along side the regular documentation.

Of course it is possible to also make a more complex version that utilises the wordpress media library or even seperate additional file downloads manager, but I think that this is not necessary. There are already many download plugins out there that are full of bloat. What is missing is a simply way to serve files alongside documents.

If required (and to be more W3C compliant) additional meta info can also easily be included, for example...

My Doc Title [url="mysite.com/mycontent" alt="my content download" class="myCustomCssClass"]

All of this is easily translatable into standard HTML / CSS which allows it to easily adopt the standard theme / template style being used.

/DM

Fantastic plugin.

The Editor role seems to only be able to create drafts - they can't publish any docs.

Is there any change that can be made to allow the Editor to publish new docs?

I think this is a bug- I see the option to add translations under editing a category but it doesn't seem to have any effect. Using the free version of Polylang for i18n. Post translations seem to work fine.

Hi there,
Thanks for the useful plugin. We've been moving our docs over to it and I have a question.

Currently whatever you set as the archives page lists the documentation by category and section, which is great. It doesn't show up on translated pages though, and I was wondering if there's a way to get the same listing using a shortcode or a plugin, possibly also with limiting the categories. I've tried some post archive plugins, and custom query plugins, but don't seem to get the same structure without getting my hands dirty.

On doing the search, it's throwing this error in console - Uncaught TypeError: Cannot read property 'outerHTML' of undefined in assets/js/script.js at https://github.com/nk-o/docspress/blob/169dc3941cc064046c7b07addec8d5d236f8eb5e/src/assets/js/script.js#L64

To debug, I enabled the troubleshooting mode, only kept the DocsPress and default theme activated and it worked just fine, then I enabled Elementor and Elementor Pro, and it stopped working.

To find the root cause, I logged the output of $data and realized that in the default theme setup, the array of result contained the .docspress-search-list element whereas in the Elementor template, the length of matching element was 0.

We are using the plugin here - https://pixify.net/kb/designer-powerup-for-elementor/getting-started/

@nk-o, can you please look into this?

Good afternoon, thank you for this wonderful plugin.

I see on the support posts that you were thinking of adding the categories as a way to filer.
This was implemented on the current version, but how do you use it?

I tried:

[display-posts category="category-name-example"]
[display-docs category="category-name-example"]

But had no success…

Storefront default Woo theme, I used template full-width for the page.
But page still loads sidebar css.

Any way to get rid of this sidebar class and css for doc archives?

help me

I noticed plugin adds hashlinks to headings.
It would be cool to include hash links in the left navigation menu.

Hi there

Something I miss from this plugin is the ability to render de docs archive through a custom shortcode to, for example, display some docs from a specific category only or to displaythe docs archive on a custom page

Could you add a shortcode with some attributes to allow include exclude single docs and by category?

Related topic: https://wordpress.org/support/topic/breadcrumbs-errors/

Add possibility to create changelogs using Gutenberg editor.

Example: https://desktop.github.com/release-notes/

These changelogs parsed from json file - https://github.com/desktop/desktop/blob/master/changelog.json

Hi, Can somebody add an "Export as HTML" link on View/Client side of Documentations just with the same functionality as in admin side?

That could be best option to make archive of specific versions of documentations or even produce offline PDF version.

Pretty sure this is my fault, but I don't know what I might have done. ;)

1. Admin -> Docspress -> Settings -> Sidebar->"Display Search" is checked. So is Sidebar -> Ajax.
2. File System -> Plugins > Docspress -> Templates -> Single -> Sidebar.php appears correct and unmodified.
3. When displaying the page containing the DocsPress Article Block, the search field renders, the TOC renders, and the Content renders ...
4. But there is no submit button. And no js/ajax appears to activate upon typing or "enter". No results appear. But...
5. The console displays the following error:

script.min.js?ver=2.3.0:1 Uncaught TypeError: Cannot read properties of undefined (reading 'outerHTML')
    at Object.success (script.min.js?ver=2.3.0:1:1083)
    at c (jquery.min.js?ver=3.6.1:2:28327)
    at Object.fireWith [as resolveWith] (jquery.min.js?ver=3.6.1:2:29072)
    at l (jquery.min.js?ver=3.6.1:2:80045)
    at XMLHttpRequest.<anonymous> (jquery.min.js?ver=3.6.1:2:82499)

6. And the Search form HTML looks correct:

        
    <form role="search" method="get" class="docspress-search-form" action="https://naturallawinstitute.com/">
        <input type="search" class="docspress-search-field" placeholder="Type to search" value="" name="s" autocomplete="off">
        <input type="hidden" name="post_type" value="docs">
        <input type="hidden" name="child_of" value="263501">                           
    </form>
    <div class="docspress-search-form-result"></div>
        

Advice?
Thanks.

The download button after export is redirected to a 404 page (/wp-admin/false).

We have multiple plugins and each category has lots of long articles. The left navigation sidebar is nice, but that also means that if we have all article titles enabled, it becomes pretty long and hard to find.

While surfing on the Slack's help website, I realized that it's kinda the perfect solution to make it easier to find articles as well as put it in a better UI with Table of Contents for each article to skim through quickly.

Any plans to add a template like that? (Slack eg: https://slack.com/intl/en-in/help/articles/360017938993-What-is-a-channel)

If not, can you quickly guide me through how can I override the templates from theme (is that possible?) or how do I proceed to create my own template in a non-destructible way so that the plugin updates don't affect it?

The meta on the archive page is hard set as "DocsPress" regardless of settings in the SEO Framework plugin.

Hi Guys,

The breadcrumb incorrectly displays. It does not take the current path but instead uses 'doc'

Please see image below

Categories will split documentation list. Example:

Hi there!

Actually on the archive page your documents gets separated by classes

On the single document sidebar, this causes that docs are not correctly ordered (because they have a custom order per category) and much more, they are not separated by the same categories

Would be awesome to have a setting to display the docs listing separated by categories too on the sidebar area

Uncaught TypeError: n.closest(...).addClass is not a function