PHPackages                             immrdimm/docketwiki - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing &amp; Serialization](/categories/parsing)
4. /
5. immrdimm/docketwiki

ActiveLibrary[Parsing &amp; Serialization](/categories/parsing)

immrdimm/docketwiki
===================

Simple and fast wiki and knowledge base

v1.0.0(4y ago)763MITPHPPHP &gt;=7.3.0

Since Apr 25Pushed 4y ago1 watchersCompare

[ Source](https://github.com/ImMrDimm/docketwiki)[ Packagist](https://packagist.org/packages/immrdimm/docketwiki)[ Docs](http://docketwiki.immrdimm.ru)[ RSS](/packages/immrdimm-docketwiki/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

DocketWiki
==========

[](#docketwiki)

[![Version](https://camo.githubusercontent.com/715a046b77fea4db19b8fabb2881116bd07afd98013ef18fc490215955ccef91/687474703a2f2f706f7365722e707567782e6f72672f696d6d7264696d6d2f646f636b657477696b692f76657273696f6e)](https://packagist.org/packages/immrdimm/docketwiki)[![Total Downloads](https://camo.githubusercontent.com/7a7a65124e754e3b6468fe402d6c54e97e798433a32446ae382cc125b4dd8cdd/68747470733a2f2f706f7365722e707567782e6f72672f696d6d7264696d6d2f646f636b657477696b692f642f746f74616c2e737667)](https://packagist.org/packages/immrdimm/docketwiki)[![License](https://camo.githubusercontent.com/f395ccc4dcbeb5defc17b7550712c936058b3aef6f06c8d336d8c68288c4ea4e/68747470733a2f2f706f7365722e707567782e6f72672f696d6d7264696d6d2f646f636b657477696b692f6c6963656e73652e737667)](https://packagist.org/packages/immrdimm/docketwiki)

[![DocketWiki](https://camo.githubusercontent.com/b927112b40dca860de61853b3e9a1a80afadd8004de405cef073068a49e93e98/68747470733a2f2f692e696d6775722e636f6d2f4c5259616543512e6a706567)](https://camo.githubusercontent.com/b927112b40dca860de61853b3e9a1a80afadd8004de405cef073068a49e93e98/68747470733a2f2f692e696d6775722e636f6d2f4c5259616543512e6a706567)

See demo here [DocketWiki](http://docketwiki.immrdimm.ru)

- [About](#about)
- [How To](#how-to)
    - [Getting Started](#getting-started)
    - [Requirements](#requirements)
    - [Install](#install)
    - [Files, Directories and Structure of DocketWiki](#files-directories-and-structure-of-docketwiki)
    - [Configuration](#configuration)
        - [Config structure](#config-structure)
        - [Main settings](#main-settings)
        - [Sidebar navigation settings](#sidebar-navigation-settings)
            - [Subtitle item](#subtitle-item)
            - [Menu item](#menu-item)
- [Elements](#elements)
    - [Headings](#headings)
    - [Texts and other](#texts-and-other)
        - [Paragraphs](#paragraphs)
        - [Blockquote](#blockquote)
        - [Code block](#code-block)
        - [Links](#links)
        - [Footnotes](#footnotes)
        - [Lists](#lists)
            - [Unordered list](#unordered-list)
            - [Ordered list](#ordered-list)
            - [Nested list](#nested-list)
    - [Tables](#tables)
    - [Images](#images)
    - [Alerts](#alerts)
    - [Accordeon](#accordeon)
    - [Icons](#icons)

About
=====

[](#about)

DocketWiki is simple and static documentation for your project or knowledge base

DocketWiki based on MD-files without Database

You do not need powerfull server, database and difficult settings to start

Download archive, upload and unzip on your server. That's all

Based on [ParseDown](https://github.com/erusev/parsedown) and [ParseDown Extra](https://github.com/erusev/parsedown-extra) by [Emanuil Rusev](https://github.com/erusev)

Full support of HTML tags and markdown

How To
------

[](#how-to)

### Getting Started

[](#getting-started)

Before you start, check requirements page

### Requirements

[](#requirements)

The DocketWiki has a few system requirements.

You should ensure that your web server has the following minimum PHP version and extensions:

- PHP &gt;= 7.0
- Fileinfo PHP Extension
- JSON PHP Extension
- No database needed!

### Install

[](#install)

Unpack .zip-file into your webserver folder.

That's all!

### Files, Directories and Structure of DocketWiki

[](#files-directories-and-structure-of-docketwiki)

- assets folder contains custom styles, scripts, images and other resources for project
    - css folder contains styles
    - js folder contains custom java-script files
    - favicon folder contains favicons
    - icons folder contains icons for menu
- documents folder contains all your MD-files
    - errors folder contains templates for error-pages
- classes folder contains project classes
- libs folder contains additional third-party libs
- layouts folder contains templates for view
    - sidebar folder contains sidebar views
    - template folder contains main views
- index.php entry point of all project
- .htaccess rules and conditions for webserver
- config.json configuration file
- config\_example.json additional example of configuration file

### Configuration

[](#configuration)

All settings of your DocketWiki placed on config.json at root-folder

You can use config.json of this demo or rename config\_example.json and place your changes.

#### Config structure

[](#config-structure)

Config contain:

- Main Wiki settings
- Sidebar navigation settings

#### Main settings

[](#main-settings)

First block of settings contain next code:

```
"version": "1.0.0",
"wiki_name": "DocketWiki",
"wiki_root_url": "/wiki/",
"start_page": "about",

```

where is:

- version of your Wiki
- wiki\_name name of your Wiki
- wiki\_root\_url place '/' if it is root folder, or '/folder\_name/' if it is a subfolder of existing website
- start\_page place started url of your Wiki

#### Sidebar navigation settings

[](#sidebar-navigation-settings)

Sidebar navigation settings contain an array with all menu-items like this:

```
"sidebar":{
   "menu":[
      {
         "type":"link",
         "icon":"icon1",
         "name":"About",
         "url":"about"
      },
      {
         "type":"subtitle",
         "name":"How To"
      },
      {
         "type":"link",
         "icon":"icon1",
         "name":"Getting Started",
         "url":"how_to/getting_started"
      }
    ]
  }

```

where is:

- sidebar - root node for sidebar settings. required.
- menu - root node for menu settings. required.
- menu sub-nodes can be tow types: simple menu-item with icon, text and bubble or subtitle-text

##### Subtitle item

[](#subtitle-item)

Subtitle item - simple text without links, icons etc.

```
{
   "type":"subtitle",
   "name":"How To"
}

```

- type - type of item. required.
- name - text of item. required.

##### Menu item

[](#menu-item)

Menu item - link to page of DocketWiki

```
{
   "type":"link",
   "icon":"icon1",
   "name":"Getting Started",
   "url":"how_to/getting_started",
   "bubble": "success",
   "bubble_text": "some text"
}

```

- type - type of item. required.
- icon - icon of item. you can choose icon on Icons page of this DocketWiki
- name - text of item. required.
- url - url-link of item. required.
- bubble - bubble-type of item. can be success, warning, danger, info and idle
- bubble\_text - bubble-text of item.

Elements
--------

[](#elements)

### Headings

[](#headings)

```
# Heading H1
## Heading H2
### Heading H3
#### Heading H4
##### Heading H5
###### Heading H6

```

### Texts and other

[](#texts-and-other)

#### Paragraphs

[](#paragraphs)

You can create a new paragraph by leaving a blank line between lines of text.

#### Styling text

[](#styling-text)

Main styles of text do you need below:

StyleSyntaxExampleOutputBold\*\* \*\*\*\* Bold text \*\*\*\* Bold text \*\*Italic\* \*\* Italic text \*\* Italic text \*Strikethrough~~ ~~~~ Mistaken text ~~Mistaken textBold and nested italic\*\* \*\* and \_ \_\*\* Bold and \_ italic \_ text \*\*\*\* Bold and *italic* text \*\*All bold and italic\*\*\* \*\*\*\*\*\* Totaly bold and italic \*\*\*\*\*\* Totaly bold and italic \*\*\*#### Blockquote

[](#blockquote)

How to use:

`> Something important or not important`

#### Code block

[](#code-block)

To format code or text into its own distinct block, use triple backticks

```
  ``` Place your code here ```

```

#### Links

[](#links)

How to use:

```
[link text](link url)

```

#### Footnotes

[](#footnotes)

How to use:

```
Some text with footnote[^1].
Do not forget[^2] place the footnote!

```

### Lists

[](#lists)

#### Unordered list

[](#unordered-list)

```
- List item 1
- List item 2
- List item 3

```

#### Ordered list

[](#ordered-list)

```
1. List item 1
2. List item 2
3. List item 3

```

#### Nested list

[](#nested-list)

You can create nested list:

```
1. First list item
   - First nested list item
     - Second nested list item

```

### Tables

[](#tables)

Standart table using like this:

```
| Worker   | Salary  |
| ---      | ---     |
| James    | 1 200 $ |
| Anton    | 1 440 $ |

```

### Images

[](#images)

How to use:

```
![There is an image](https://i.imgur.com/j6EIdA4.png)

```

### Alerts

[](#alerts)

DocketWiki exists some custom alerts

Example:

```

Notice Text

```

Available types of notices:

- notice
- notice notice--success
- notice notice--warning
- notice notice--danger
- notice notice--info

#### Accordeon

[](#accordeon)

If you want to hide some content into accordeon, you can place this code:

```

  Accordeon: Show and Hide

  Some hided content

```

#### Icons

[](#icons)

DocketWiki uses Feather Icon Pack for styling your sidebar-menu.

#### HTML tags

[](#html-tags)

DocketWiki has full support of custom HTML-tags

You can place something like this:

```
Custom a-tag link

```

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1483d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/13995b7e6c3bb9c9e9464d85ea1cadaa837120a95ea1a58d81670bf28707ff14?d=identicon)[ImMrDimm](/maintainers/ImMrDimm)

---

Top Contributors

[![ImMrDimm](https://avatars.githubusercontent.com/u/24388051?v=4)](https://github.com/ImMrDimm "ImMrDimm (10 commits)")[![TemaYud](https://avatars.githubusercontent.com/u/4264965?v=4)](https://github.com/TemaYud "TemaYud (1 commits)")

---

Tags

parsermarkdownwikiknowledge

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/immrdimm-docketwiki/health.svg)

```
[![Health](https://phpackages.com/badges/immrdimm-docketwiki/health.svg)](https://phpackages.com/packages/immrdimm-docketwiki)
```

###  Alternatives

[erusev/parsedown

Parser for Markdown.

15.0k151.8M732](/packages/erusev-parsedown)[league/commonmark

Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and GitHub-Flavored Markdown (GFM)

2.9k404.0M702](/packages/league-commonmark)[erusev/parsedown-extra

An extension of Parsedown that adds support for Markdown Extra.

84314.8M192](/packages/erusev-parsedown-extra)[texy/texy

Texy converts plain text in easy to read Texy syntax into structurally valid (X)HTML. It supports adding of images, links, nested lists, tables and has full support for CSS. Texy supports hyphenation of long words (which reflects language rules), clickable emails and URL (emails are obfuscated against spambots), national typographic single and double quotation marks, ellipses, em dashes, dimension sign, nonbreakable spaces (e.g. in phone numbers), acronyms, arrows and many others. Texy code can optionally contain HTML tags.

161838.9k15](/packages/texy-texy)[parsedown/parsedown

Parser for Markdown.

21342.8k3](/packages/parsedown-parsedown)[tovic/parsedown-extra-plugin

Configurable Markdown to HTML converter with Parsedown Extra.

5933.7k](/packages/tovic-parsedown-extra-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
