QuickDocs

Descrição

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.

Imagens de tela

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

Avaliações

Não existem avaliações para esse plugin.

Colaboradores e desenvolvedores

“QuickDocs” é um software com código aberto. As seguintes pessoas contribuíram para este plugin.

Colaboradores

Registro de alterações

1.0.0

  • First Version