Skip to content

kyletcooper/quickdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

=== QuickDocs ===
Contributors: wrdstudio
Tags: documentation, code, software, guide, tutorial, coding, document
Requires at least: 5.2
Tested up to: 6.1
Requires PHP: 7.4.0
License: GPLv3 or later
Stable tag: 1.0.0
License URI: https://www.gnu.org/licenses/gpl-3.0.html

Quickly create modern, functional documentation without making a new site.

== Description ==
QuickDocs lets you quickly create modern, functional documentation pages that let you skip the setup and go straight to the content.

= Add Documentation to your Existing Website =
QuickDocs is a plugin, not a theme. This allows you to add documentation as a seperate section of your existing website and don't need a new subdomain or site. Only your documentation pages use our templates.

= Modern Styling =
Our docs look beautiful out of the box, with support for organised typograhpic heirarchy, tables, lists, and code. Plus you can customise the background, font and accent colour to match your brand.

= Dark & Light Mode =
We automatically detect and enable dark-mode and allow users to manually toggle the setting. We also support reducing motion to limit animations on the page.

= Organised Sidebar Menu =
Connect your pages with a toggleable sidebar menu to navigate across your documentation. The menu can be specified per page, per topic or across all documentation easily with our inherited sidebar system.

= Gather User Feedback =
Allow users to mark pages as helpful or unhelpful easily so you can see what pages need improvement.

= Synax Highlighting =
Automatically highlight your code blocks with support for JavaScript, HTML, CSS, PHP and C-Like languages using highlight.js. You can set the language of a code block by added the class 'lang-xxxx'.

= Live Search =
Make it easy for users to find the right documentation with our live search feature that searches documentation as you type.

= Back & Forward Navigation =
Your footer automatically chooses a next and previous page based on the sidebar menu.

= On Page Table of Contents =
See what a page covers at a glance with our auto-generated table of contents. It tracks the nearest heading as you scroll and adds anchor tags to headings so you can jump around the page.

= Bulk Importing =
Import markdown, plain text and HTML files in bulk to quickly transfer your existing documentation.

== Screenshots ==
1. Beautiful domcumentation out of the box.
2. Built-in dark mode support.
3. Support for styled tables, lists and code blocks.
4. Automatic syntax highlighting for a variety of languages.
5. Easily search for the right article.
6. Manage the links between pages easily using menus.
7. See which pages are helping users and which aren't.
8. Group your documentation articles and give each topic it's own sidebar.

== Changelog ==

= 1.0.0 =
* First Version

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published