forked from weDevsOfficial/wedocs-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
175 lines (115 loc) · 7.38 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
=== weDocs - Knowledgebase and Documentation Plugin for WordPress ===
Contributors: tareq1988, wedevs
Donate link: https://tareq.co/donate/
Tags: document, documentation, knowledge base, knowledgebase, support, faq
Requires at least: 4.6
Tested up to: 5.8
Requires PHP: 5.4
Stable tag: 1.7.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Create great looking documentation for your products.
== Description ==
Create great looking documentation for your products. Organize your product documentation in your site, beautifully!
* [Documentation](https://wedocs.co/docs/wedocs/getting-started/?utm_source=wporg&utm_medium=readme&utm_campaign=docs)
* [Github](https://github.com/tareq1988/wedocs-plugin/)
You can host docs inside your WordPress, create/add new docs, organize with ordering, tags and even fetch docs from external sites using this plugin.
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.
### Contribute ###
This may have bugs and lack of many features. If you want to contribute on this project, you are more than welcome. Please fork the repository from [Github](https://github.com/tareq1988/wedocs-plugin).
### Author ###
Brought to you by [Tareq Hasan](https://tareq.co) from [weDevs](https://wedevs.com)
== 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.
== Frequently Asked Questions ==
= What is Appsero =
weDocs uses [Appsero](https://appsero.com) 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](https://appsero.com/privacy-policy/).
== Screenshots ==
1. Admin UI
2. Documentation on Admin UI builder
3. Actions UI
4. Switch to classic UI
5. Classic docs UI
6. All docs in frontend via shortcode
7. Single docs view with navigation
8. Search widget
9. Search widget in frontend
== Changelog ==
= v1.7.1 (15th November, 2021) =
* **Fix:** Upgraded to SweetAlert2 version 11.1.10
* **Fix:** Links in the heading (h1, h2, h3) are now hidden on printing mode
= v1.7 (3rd September, 2021) =
* **New:** Added Astra theme support. Single docs pages were narrow in width before, now it'll be full page width.
= v1.6.3 (28th July, 2021) =
* **Enhancement:** WordPress 5.8 compatibility.
* **Enhancement:** Few modal texts were not translated properly, that is fixed now.
= v1.6.2 (2nd Sep, 2020) =
* **Fix:** Fix REST API permission callback issue in WP 5.5.
= v1.6.1 (5th June, 2020) =
* **New:** Load CSS and JS files only for Docs. Fixes [#104](https://github.com/tareq1988/wedocs-plugin/issues/104)
* **Fix:** Added missing textdomains. Fixes [#105](https://github.com/tareq1988/wedocs-plugin/issues/105)
* **Fix:** Fix search API. Was breaking due to namespace issue with WP_Query. Fixes [#108](https://github.com/tareq1988/wedocs-plugin/issues/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 (<code>items</code>) to limit no. of items shown. [#59](https://github.com/tareq1988/wedocs-plugin/pull/59/files)
* **New:** Added a new filter <code>wedocs_email_feedback_to</code> for outgoing mail to address. [#63](https://github.com/tareq1988/wedocs-plugin/issues/63)
* **New:** Added theme wrapper support. Now developers will be able to put dynamic start and end divs and tags in the <code>single-docs.php</code> template.
* **New:** Show 3rd level doc in the admin UI builder.
* **New:** Added automatic anchor tags in docs for <code>h2</code> and <code>h3</code> tags. Bookmarking is now very easy! Thanks to [anchorjs](https://github.com/bryanbraun/anchorjs/).
* **Fix:** Bug with quotes in the doc title. [#66](https://github.com/tareq1988/wedocs-plugin/issues/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) =
* **Fix:** Remove WPUF dependency on 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 <code>wedocs_breadcrumbs_html</code> 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) =
* SKIPPED VERSION due to release mistake
= 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
== Upgrade Notice ==
Nothing here yet