weDocs – Knowledgebase and Documentation Plugin for WordPress

Description

Create great looking documentation for your products. Organize your product documentation in your site, beautifully!

你可以在你的WordPress中存放文档,创建/添加新的文档,组织排序,标签,甚至使用这个插件从外部站点获取文档。

This plugin is extremely handy for delivering long and detailed documentation of your WordPress product / plugin by bundling this with it.

weDocs makes browsing and creating documentation a fresh and streamlined experience within the familiarity of your WP environment.

贡献

这可能有错误并且缺少许多功能。 如果您想为这个项目做出贡献,欢迎您。 请从Github上fork wedocs-plugin

作者

Brought to you by Tareq Hasan from weDevs

屏幕截图

  • 管理界面
  • Documentation on 管理界面 builder
  • Actions UI
  • 切换到经典界面
  • 经典文档界面
  • All docs in frontend via shortcode
  • Single docs view with navigation
  • 搜索小工具
  • 搜索小工具 in frontend

Installation

Extract the zip file and just drop the contents in the wp-content/plugins/ directory of your WordPress installation and then activate the Plugin from Plugins page.

常见问题

What is Appsero

weDocs uses Appsero SDK to collect some telemetry data upon user’s confirmation. This helps us to troubleshoot problems faster & make product improvements.

Appsero SDK does not gather any data by default. The SDK only starts gathering basic telemetry data when a user allows it via the admin notice. We collect the data to ensure a great user experience for all our users.

Integrating Appsero SDK DOES NOT IMMEDIATELY start gathering data, without confirmation from users in any case.

Learn more about how Appsero collects and uses this data.

Reviews

2020年4月15日
I don't know where to start expressing my excitement about this plugin. I guess I should start thanking Tareq Hasan for providing it for free. I am a developer myself and I know how much work, blood and sweat goes into such thing. Kudos! weDocs is intuitive to use. A few clicks and you have your first documentation online. Digging more into it reveals a lot of possibilites to adjust it to your needs. When I first started using it I made a little blog post about how it grew on me. In that post I talked about CSS adjustments I did. Tareq's recent release of version 1.6.0 now offers even more beauty for the front-end. I just love this plugin and during my use of it I though about two improvements that would make this already great plugin even a tad better. It would be great if the styles that come with wweDocs were editable on the settings page. When adding a new section to a Doc, or a new page to a section, an order number is assigned to it. Via these order numbers you can influence the order of the pages in a section, or the order of sections in a Doc. The automatically created numbers start with 1 and each new object adds +1. In more than one case I ran into the need to reorder the sections or pages. I had to edit all pages to enter thew new order numbers. My suggestion: Start with 100 and for each new section or page, add +100. You then have an initial sequence of 100, 200,300 and so on. That makes it very easy to edit a section or page and change the order number to let's say 250 to move it in between 200 and 300. In any case, 5 stars are more than deserved for weDocs! Best regards, George PS: Tareq, I accidentally clicked away the metrics collection request after installing 1.6.0. Is there any way to acitvcate it still?
2020年2月27日
The plugin is very easy to use. It makes creating the documentation quite easy. It also displays them with a reasonable appearance. The documentation is also very straightforward. It also does not bother you with "rate us" notifications. I highly recommend it.
2020年1月28日
Hi friend, When you do subarticles, this is not shown on the page if you click on the parent. Is there a way they look as much as each other? In first impression? Thx
阅读所有的50评价

Contributors & Developers

“weDocs – Knowledgebase and Documentation Plugin for WordPress” 是开源软件。 以下人员对此插件做出了贡献。

Contributors

“weDocs – Knowledgebase and Documentation Plugin for WordPress” 已翻译成6 语言环境。 感谢译者的贡献。

将“weDocs – Knowledgebase and Documentation Plugin for WordPress”翻译成您的语言。

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

更新日志

v1.6.1 (5th June, 2020)

  • New: Load CSS and JS files only for Docs. Fixes #104
  • Fix: Added missing textdomains. Fixes #105
  • Fix: Fix search API. Was breaking due to namespace issue with WP_Query. Fixes #108

v1.6 (8 April, 2020)

  • New: Added expanding functionality for nested docs in the frontend. From the single doc, you’ll be able to see all documentation by clicking on the toggle icon from the sidebar.
  • Refactor: The plugin has been refactored to use PHP Namespacing. Now the plugin code is more organized.
  • Other: Added Appsero SDK to collect telemetry data.

v1.5 (11 July, 2019)

  • New: Added REST API support
  • New: Added comment support in single docs

v1.4.1 (26 August, 2018)

  • Fix: Updated Vue.js version to 2.5.16 and added minified version as well.

v1.4 (25 August, 2018)

  • New: Added new shortcode attribute (items) to limit no. of items shown. #59
  • New: Added a new filter wedocs_email_feedback_to for outgoing mail to address. #63
  • New: Added theme wrapper support. Now developers will be able to put dynamic start and end divs and tags in the single-docs.php template.
  • New: Show 3rd level doc in the admin UI builder.
  • New: Added automatic anchor tags in docs for h2 and h3 tags. Bookmarking is now very easy! Thanks to anchorjs.
  • 修复: 文档标题中有引号的Bug。#66
  • Improved: Flush rewrite rules after plugin activates. Fixes the long time permalink issues with 404.
  • Improved: Disable page scrolling when the feedback modal is open.

v1.3.3 (8 November, 2017)

  • Improved: Proper user roles/permission checking when creating and deleting a doc. Previously, everyone who could access the UI, could create and delete any doc. No user capability checking was done previously, this version fixes the issue.

v1.3.2 (15 October, 2017)

  • 修复:删除WPUF对weForms upsell的依赖
  • New: Show docs and taxonomy in REST API. Fixes #44
  • New: List child articles if present in single doc. Fixes #34
  • New: Added page-atrribute support for the Docs post type. Now you can change the doc parent from the single docs edit page.
  • Improved: Upgrade Vue to 2.5.1 from 1.0.16
  • Improved: Every user should see the switch to classic UI url

v1.3.1 (24 August, 2017)

  • [improve] Added weForms reference

v1.3 (21 August, 2017)

  • [fix] Add missing text domains and Qtranslate support on doc feedback email
  • [fix] Moved final breadcrumb echo out of if parent clause and removed resultant excess delimiter. #23
  • [fix] Translate the send button. #38
  • [fix] Printing timeout extended to 2 seconds
  • [fix] Wrong tag post_type linking in edit-tags.php in admin. #40
  • [improve] Added filter on wedocs post type
  • [new] Added Spanish language (#37)
  • [new] Added docs page settings, removed post archive. Added settings “Docs Home” to use it in breadcrumb as Docs home. Created the docs page on activation if not exits.
  • [new] Added filter wedocs_breadcrumbs_html to customize breadcrumb HTML
  • [new] Added wedocs_get_publish_cap() function for dynamic role binding on admin menu, pending post status support. #42

v1.2.1 (1 November, 2016)

  • [fix] Auto print dialog missed

v1.2 (1 November, 2016)

  • [new] Added print option
  • [new] Contact modal
  • [new] Responsiveness
  • [new] Microdata implementation (schema.org)
  • [new] Last updated date
  • [new] Settings page

v1.1 (24 October, 2016)

  • 由于发布错误而跳过了版本

v1.0 (24 October, 2016)

  • [new] Added Persian language
  • [new] Add french translation, responsiveness and QtranslateX full support
  • [fix] Attach $event object to addArticle method
  • [fix] Typo in the key name (causes a PHP notice on line 111 $args['after']).

v0.1 (2 march, 2016)

  • Initial release