
內容簡介
QuickDocs 可讓您快速建立現代且功能完備的文檔頁面,讓您跳過設置步驟,直接進入內容。
將文檔添加至現有網站
QuickDocs 是一個外掛程式,而不是佈景主題。這使您可以將文檔添加為您現有網站的獨立部分,無需新的子域名或網站。只有您的文檔頁面使用我們的模板。
現代化樣式
我們的文檔即插即用,支援有組織的排版層次結構、表格、列表和代碼。此外,您可以自定義背景、字體和強調顏色以配合您的品牌。
暗黑模式和亮色模式
我們會自動偵測和啟用暗黑模式,並允許用戶手動切換設置。我們還支援減少動畫以限制頁面上的動畫。
有組織的側邊欄選單
透過可切換的側邊欄選單,將您的頁面連接在一起,以瀏覽您的文檔。您可以使用我們的繼承式側邊欄系統來簡單地指定每頁、每個主題或所有文檔的菜單。
收集用戶反饋
讓用戶輕鬆將頁面標記為有幫助或無幫助,以便您了解哪些頁面需要改進。
語法突顯
使用 highlight.js 自動突顯支援 JavaScript、HTML、CSS、PHP 和 C-Like 語言的代碼塊。您可以通過添加類別 "lang-xxxx" 來設置代碼塊的語言。
即時搜索
透過我們的即時搜索功能,讓用戶輕鬆找到正確的文檔,系統會在您輸入時搜索文檔。
回到上一頁和前往下一頁的導航
根據側邊欄菜單,您的頁腳會自動選擇下一頁和上一頁。
頁內目錄
通過我們自動生成的目錄,一覽當前頁面的內容。當您滾動頁面時,它會跟踪最近的標題並向標題添加錨點標記,以便您在頁面中快速跳轉。
批量導入
批量導入 markdown、純文本和 HTML 文件,快速轉移現有的文檔資訊。
外掛標籤
開發者團隊
原文外掛簡介
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.
