WordPress.org

Taiwan 正體中文

取得 WordPress
WordPress.org

Plugin Directory

editant Docs

editant Docs

由 editant 開發
下載

外掛說明

editant Docs gives your site a proper documentation section: articles grouped into categories, with a persistent, foldable sidebar for navigation. It draws and styles its own index and article pages, so it looks finished the moment you activate it and works the same on any theme, block or classic.

The look is the editant brand out of the box, and you can make it your own from a single settings page: keep the editant header, replace it with your own logo and name, or hide it, set an accent colour to match your brand, and choose the label for your section, for example “Documentation”, “Help”, or “Knowledge base”.

Because the plugin renders and styles itself, it never depends on your active theme. The IBM Plex fonts are bundled with the plugin and served from your own site, and the styling is scoped so it neither leans on, nor leaks into, your theme.

What’s included

  • A documentation post type with hierarchical categories.
  • A self-contained two-column layout – foldable sidebar plus article – drawn by the plugin on any theme.
  • Drag-and-drop reordering of categories and the articles within them.
  • A header you control: the editant logo and name by default, your own logo and/or name, or no header at all.
  • An accent colour that drives links and the active sidebar item.
  • A configurable section label for the index heading.
  • A configurable URL base – set it in the admin (with a developer filter override) so your docs can live at /docs, /help, /kb, or wherever you like.
  • Bundled IBM Plex fonts – no dependency on the active theme and no font CDN.
  • One-click sample content you can load and remove from the Settings page (no WP-CLI needed).
  • Translation-ready.

Privacy

editant Docs stores its settings in your own WordPress database and sends no data to any external service. The bundled fonts are served from your own site, not from a third-party font CDN.

螢幕擷圖

The documentation index: the foldable sidebar beside a category-grouped list of articles.
The documentation index: the foldable sidebar beside a category-grouped list of articles.
A single article with the sidebar, the current article highlighted.
A single article with the sidebar, the current article highlighted.
The Settings page: header choice, accent colour, content label, URL base, and one-click sample content.
The Settings page: header choice, accent colour, content label, URL base, and one-click sample content.
The Reorder screen: drag categories and articles into the order you want.
The Reorder screen: drag categories and articles into the order you want.

適用於區塊編輯器

這個外掛提供 2 個可供區塊編輯器使用的區塊。

  • Sidebar Nav
  • Post Category

安裝方式

  1. Upload the plugin to your /wp-content/plugins/ directory, or install it via Plugins -> Add New.
  2. Activate editant Docs through the Plugins menu.
  3. Add categories under editant Docs -> Categories, then write articles under editant Docs -> Add new doc article and assign each one a category.
  4. Visit /docs to see your documentation. Reorder categories and articles under editant Docs -> Reorder, and rebrand the look under editant Docs -> Settings.

Requirements:

  • WordPress 6.5 or later
  • PHP 8.1 or later

常見問題集

Where does my documentation appear?

The index is at /docs and each article is at /docs/<article-slug>. Both are drawn and styled by the plugin, so they look the same on any theme.

Can I change the /docs URL?

Yes. Go to editant Docs -> Settings and set the URL base to whatever you like, for example “help” or “kb”. The links update as soon as you save, with no need to touch the Permalinks screen. Changing the base means existing links to the old address stop working. Developers can still override the base with the editant_docs_archive_base filter.

Does it work on any theme?

Yes. The plugin renders its own single-article and index layouts and ships its own styling and fonts, so it works identically on block themes and classic themes without any theme configuration.

Can I use my own branding?

On the editant Docs Settings page you can keep the editant header, replace it with your own logo and/or name, or hide the header entirely, and set an accent colour to match your brand. You can also change the label shown on the index, for example to “Help” or “Knowledge base”.

How do I add the sample content?

Sample content is optional and never installed automatically. Go to editant Docs -> Settings and click “Load sample content” to add a few neutral categories and articles that are safe to edit or delete. “Remove sample content” deletes only what the plugin added, never your own articles.

If you prefer the command line, the same content can be loaded with WP-CLI:

wp eval-file wp-content/plugins/editant-docs/bin/seed.php

Does uninstalling delete my articles?

No. Uninstalling removes only the plugin’s settings row. Your documentation articles and categories are your content and are left untouched. Delete them yourself first if you want them gone.

使用者評論

這個外掛目前沒有任何使用者評論。

參與者及開發者

以下人員參與了開源軟體〈editant Docs〉的開發相關工作。

參與者

將〈editant Docs〉外掛本地化為台灣繁體中文版

對開發相關資訊感興趣？

任何人均可瀏覽程式碼、查看 SVN 存放庫，或透過 RSS 訂閱開發記錄。

變更記錄

1.0.1

  • Point the plugin homepage at the Free Tools page. No functional change.

1.0.0

  • Initial release.

中繼資料

評分

這個項目尚無任何評論記錄。

撰寫評分

查看全部使用者評論

參與者

技術支援

使用者可在技術支援論壇提出意見反應或使用問題。

檢視技術支援論壇