https://github.com/jeffersonrucu/wp_docsify

Docsify for WordPress in a simple and practical way using the entire WordPress structure.
https://github.com/jeffersonrucu/wp_docsify

docsify wordpress wordpress-plugin

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jeffersonrucu/wp_docsify
• Owner: jeffersonrucu
• Created: 2025-06-13T16:52:47.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2025-06-15T23:26:15.000Z (7 months ago)
• Last Synced: 2025-07-14T13:09:09.738Z (6 months ago)
• Topics: docsify, wordpress, wordpress-plugin
• Language: PHP
• Homepage:
• Size: 43 KB
• Stars: 8
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

    

  





  A magical documentation site generator inside wordpress.



**WP Docsify** is a WordPress plugin that allows you to create and manage documentation using [Docsify](https://docsify.js.org/), leveraging `.md` files directly within your project. It's ideal for technical projects, user manuals, or any kind of versioned technical documentation.

![image](https://github.com/user-attachments/assets/00a41df7-1b7b-4987-80b7-6fbea95e2070)

![image](https://github.com/user-attachments/assets/ef471225-3e9b-4690-81e1-2c201924685a)

## 📁 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:

```bash

wp-content/plugins/wp-docsify/

```

2. Activate the plugin through the WordPress admin panel.

3. 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}/

```

2. The `README.md` file will be used as the documentation's home page.

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

## ✅ Example

```markdown

# 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 🧑‍💻