Skip to content

Docsify for WordPress in a simple and practical way using the entire WordPress structure.

Notifications You must be signed in to change notification settings

Studio-STG/WP_Docsify

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docsify

A magical documentation site generator inside wordpress.

WP Docsify is a WordPress plugin that allows you to create and manage documentation using Docsify, leveraging .md files directly within your project. It's ideal for technical projects, user manuals, or any kind of versioned technical documentation.

image

image

📁 Project Structure

wp-docsify/
├── src/
│   ├── docs/                    # Where Markdown (.md) files should be created
│   └── template-wp-docsify.php  # Template file responsible for rendering Docsify

🧩 Features

  • Direct integration of Docsify into WordPress
  • Reads .md files from the src/docs/ directory
  • Automatic rendering via a custom template
  • Simple and database-independent

🛠️ Installation

  1. Clone this repository or place the plugin in your WordPress plugins directory:
wp-content/plugins/wp-docsify/
  1. Activate the plugin through the WordPress admin panel.

  2. Create a page in WordPress and select the "WP Docsify" template (template-wp-docsify.php).

✍️ How to Use

  1. Add your documentation .md files inside the directory:
wp-content/plugins/wp-docsify/src/docs/{locale}/
  1. The README.md file will be used as the documentation's home page.

  2. Customize Docsify behavior (menus, themes, etc.) directly in the template-wp-docsify.php file.

✅ Example

# Welcome to WP Docsify

This is the initial documentation.

## Installation

Follow the steps to install and configure the plugin.

Developed by Jefferson Oliveira using the https://docsify.js.org library 🧑‍💻

About

Docsify for WordPress in a simple and practical way using the entire WordPress structure.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 74.0%
  • CSS 26.0%