DocsPress – Online Documentation

Description

Online documentation for your multiple products. Create, host and manage documentations in your WordPress site.

Links

• Live Demo
• GitHub

Features

• Multiple products support
• AJAX search
• AJAX loading for documentation pages
• Documentation categories
• Users feedback buttons
• Automatic anchor links on headings on docs content
• Comments section for articles
• Export documentation to static HTML
• Templates for theme developers
• Custom ordering

Our plugin originally based on weDocs plugin.

Screenshots

Installation

Automatic installation

Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To do an automatic install of DocsPress, log in to your WordPress dashboard, navigate to the Plugins menu and click Add New.

In the search field type DocsPress and click Search Plugins. Once you’ve found our plugin you can view details about it such as the point release, rating and description. Most importantly of course, you can install it by simply clicking “Install Now”.

Manual installation

The manual installation method involves downloading our DocsPress plugin and uploading it to your webserver via your favourite FTP application. The WordPress codex contains instructions on how to do this here.

FAQ

Initialize JS after AJAX page loaded

If you need to initialize some JS after ajax loaded, you may use DocsPress > Settings > Single Doc > AJAX custom JS section or use predefined custom event docspress_ajax_loaded:

jQuery( document ).on( 'docspress_ajax_loaded', function() {
    // your code here.
} );

Reviews

Just what you need

Avirtum May 10, 2024

A good plugin, and most importantly not overloaded with unnecessary functionality. There is only one disadvantage, as was written in the previous review, is the lack of clear documentation. But I am a programmer, I got into the code and figured it out).

There are better (explained)

RonnyDee August 4, 2023

A plugin that is supposed to be quite good, but after some time i gave up. Let’s face it, a documentation plugin that does without any documentation at all. An irony, isn’t it? Nothing is explained, there is no documentation, no faqs, nothing… sorry, but i have other things to do than find out how a plugin works.

Can this generate TOC?

ebenmonney May 7, 2023 1 reply

I like this plugin. I was wondering if it can generate a table of content for the articles. That’s the only missing feature for me.

Intuitive and easy-to-use

Mustafa Uysal March 5, 2023

It’s a useful plugin for anyone looking to create comprehensive documentation on their WordPress. With its intuitive interface and easy-to-use features, DocsPress makes it simple to create and organize documentation pages.

The best documentation plugin by far

September 23, 2022

This plugin is perfect. I’ve tried every single plugin and theme. I’d previously settled on documentor. But it’s not being maintained and bugs are emerging with every wordpress update. I’ve also tried the knowledge bases. And I thought I’d have to give up and write my own. But then, after two days of searching and trying updated versions of everything I could find, I stumbled across DocsPress. It looks like it’s based on another earlier tech. But it’s so clean, simple, and fast. I can’t recommend it highly enough. TIPS for authors 1) For a knowledgebase, use Document (product etc), Section (topic), and Article (Content) and SubArticle (sub-content). 2) For authoring books (a) use Document (Book), (b) Sections limit to “Book text”, “Notes”, “Characters”, “Locations”, “Background” (novel, script), and Research(nonfiction) etc. and (c) The build the entire book from front matter through chapters, to back-matter out of chapters (articles) and topics(sub-articles) (that’s the maximum depth: document to section to article to sub-article ). (This model is similar to say, Scrivener). NITS: There are a few nits as in anything: 1) There is no facility for controlling the layout. Which is fine except you can’t center the content on the screen or configure how wide to display the content. You have to go in and create css to do it. And the new wordpress editor makes that almost impossible. (a) I”d like to be able to configure whether the toc+article are centered or justified. (b) I’d like to be able to determine the width of article text(content). 2) Given that you can either page through Sections, or articles, each ‘section’ is in fact a separate context. Aside from that this really is the best available.

Great plugin

Marc Lacroix July 4, 2022

Thank you for making this available to everyone! Really appreciate the effort.

Contributors & Developers

Changelog

2.5.0 – May 25, 2024

• added post meta for documentation articles to set a custom title displayed in the sidebar navigation
• fixed sidebar scroll to active item wrong calculation
• fixed first loading DocSearch jump
• fixed FSE templates editing and saving JS errors
• fixed FSE templates in WordPress 6.4 new block hooks
• changed the initSidebarScroll method to run earlier without waiting for the document ‘ready’ event

2.4.4 – Feb 7, 2024

• added support for custom ordered categories (using 3rd-party plugin for custom taxonomies order)
• fixed AJAX stuck when clicking on Documentation archive link
• fixed docs archive page displaying next and prev links in meta tags in Yoast plugin

2.4.3 – Dec 26, 2023

• added automatic sidebar scroll to active item when sidebar is scrollable

2.4.2 – Nov 28, 2023

• changed tested WP version to 6.4
• changed minimal WP version to 6.2
• fixed docspress_ajax_loaded usage error because of jQuery used

2.4.0 – Nov 28, 2023

• added blocks version to v3 – allows to enable blocks iframe editor
• added output attributes with useBlockProps and get_block_wrapper_attributes in blocks
• hide FSE blocks from standard editor
• changed block templates align to wide
• changed Helpfulness old metabox to use Gutenberg API
• remove possibility to add FSE blocks multiple times
• removed jQuery dependency on frontend

2.3.1 – May 6, 2023

• added support for DocSearch
• added support for navigation category titles when enabled “Display Parent Links” setting

2.3.0 – Jul 1, 2022

• added support for FSE themes
• added CSS variables support
• improved styles for Twenty themes
• simplified styles
• changed required PHP version to 7.2
• removed IE support

2.2.7 – Dec 24, 2021

• improved feedback email template
• improved feedback mailing function (better reply to and subject lines)

2.2.6 – Dec 24, 2021

• fixed docs suggestion email Reply-To field (should refer to feedback sender email)

2.2.5 – Aug 20, 2021

• fixed private docs displaying for admins

2.2.4 – Jul 16, 2021

• tested up to WP 5.8

2.2.3 – Mar 4, 2021

• removed usage of deprecated jQuery ready event
• tested up to WordPress 5.7
• changed GitHub repo url

2.2.2 – Oct 19, 2020

• improved admin UI
• improved thumbnail size for admin documentation
• updated vendor scripts
• fixed bug when trying to delete documentation, but deleted another documentation

2.2.1 – Aug 10, 2020

• added RTL support
• fixed email template long words break

2.2.0 – Mar 23, 2020

• improved feedback suggestion email template
• enqueue assets on DocsPress pages only
• fixed breadcrumbs structured data error

2.1.2

• changed position of anchor link to right (fixes Ghost Kit numbered headings conflict)

2.1.1

• fixed DocsPress archive page title

2.1.0

• added Suggestion form option (show after user added feedback)
• added categories in admin docs list
• added possibility to change helpfulness in post metabox
• fixed anchors initialization after ajax load
• prevent cloning helpfulness meta

2.0.1

• fixed feedback click action js error
• fixed search result in the end of the excerpt text showed “1”

2.0.0

• updated overall styles
• added ajax search field in sidebar
• added 3rd-level docs support
• added categories support
• added option to hide feedback count
• added support for anchor links in content headings
• added helper styles for default wp themes
• added option to show all parent documentations in sidebar (if you don’t need multiple documentations)
• added label in breadcrumbs archive page from selected archive page title
• added option to disable comments on single doc
• added scroll to top when ajax loading doc
• changed archive docs titles to h2
• rename permalink ‘docs’ to the selected archive page slug
• fixed [] array usage
• fixed archive articles number -1
• a lot of minor changed and fixes

1.0.0

• Initial Release