PHPackages                             dbrisinajumi/yeeki - 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. [Framework](/categories/framework)
4. /
5. dbrisinajumi/yeeki

ActiveYii-extension[Framework](/categories/framework)

dbrisinajumi/yeeki
==================

Yeeki is a flexible wiki engine that can be used either as a standalone application or as an Yii framework module

0.1.0(11y ago)0119New BSD licensePHPPHP >=5.3.0

Since Mar 27Pushed 11y ago4 watchersCompare

[ Source](https://github.com/DBRisinajumi/yeeki)[ Packagist](https://packagist.org/packages/dbrisinajumi/yeeki)[ RSS](/packages/dbrisinajumi-yeeki/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

Yeeki
=====

[](#yeeki)

Yeeki is a flexible wiki engine that can be used either as a standalone application or as an [Yii framework](http://www.yiiframework.com/) module.

By default it uses [markdown](http://michelf.com/projects/php-markdown/extra/) syntax with addition of wiki-links.

Implemented features
--------------------

[](#implemented-features)

- Unicode support
- namespaces
- page index
- revision history
- ability to view specific revision
- ability to enter change summary for edit and view it at revision history page
- revision diff
- multiple markup dialects support (only markdown provided out of the box)
- cross-linking with \[\[wiki-links\]\]
- theming support
- i18n support

Requirements
------------

[](#requirements)

Currently in order to use Yeeki you need MySQL with InnoDB engine enabled. In the future it is planned to allow using it with MyISAM and PostgreSQL.

Also server should be able to run [Yii framework](http://www.yiiframework.com/).

Using Yeeki as an application
-----------------------------

[](#using-yeeki-as-an-application)

Currently you need to perform steps listed below. In the future versions all these will be covered by automated installer.

1. Unpack contents of release archive.
2. Point your webserver docroot to `www`.
3. Make sure webserver have write permissions for `www/assets` and `app/runtime`.
4. Create a database with `utf8` encoding and `utf8_general_ci` collation.
5. Provide proper database credentials in `app/config/db.php`.
6. Run `install.php` from a web browser.

Using Yeeki as a module
-----------------------

[](#using-yeeki-as-a-module)

- Copy `app/modules/wiki` to your application directory.
- Using `yiic` apply migrations with the following command:

```
yiic migrate --migrationPath=application.modules.wiki.migrations --migrationTable=wiki_migration

```

- Add `wiki` module to your web application config (usually it is `protected/config/main.php`):

```
return array(
	'basePath'=>dirname(__FILE__).DIRECTORY_SEPARATOR.'..',
	'name'=>'My cool application',

	// add the following:
	'modules' => array(
		'wiki' => array(

		),
	),

	// …
```

- Add `cache` component to your application configuration:

```
return array(
  // ...
  'components' => array(
    'cache' => array(
       'class' => 'CFileCache',
    ),
  ),
);
```

### Implementing data interfaces and configuring module

[](#implementing-data-interfaces-and-configuring-module)

In order to use wiki in your application you should implement some simple interfaces and configure module pointing to implementations. If you're using standard `Yii::app()->user`and standard RBAC then the only mandatory interface to implement is `IWikiUser`. You can find sample implementation in `app/components/WikiUser.php`. After implementing it you need to configure the module:

```
'modules' => array(
	'wiki' => array(
		'userAdapter' => array(
			'class' => 'WikiUser',
		),
	),
),

```

See also `IWikiAuth`, `IWikiSearch`.

Theming Yeeki
-------------

[](#theming-yeeki)

You can use standard Yii theming feature to theme Yeeki. For details please refer to [the definitive guide](http://www.yiiframework.com/doc/guide/1.1/en/topics.theming).

License
-------

[](#license)

Yeeki is licensed under New BSD license. That allows proprietary use, and for the software released under the license to be incorporated into proprietary products. Works based on the material may be released under a proprietary license or as closed source software. It is possible for something to be distributed with the BSD License and some other license to apply as well.

Credits
-------

[](#credits)

- Initial code and ideas: Alexander Makarov, @samdark.
- Features contribution: Mark Bryk, @mbryk.

Thanks
------

[](#thanks)

- [CleverTech](http://clevertech.biz/) for supporting this OpenSource project.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 51.4% 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

4064d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/542187ba859514d10d0952dca77df8ea889a9651b249d0b5b513da791fd2919b?d=identicon)[uldisn](/maintainers/uldisn)

---

Top Contributors

[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (18 commits)")[![ivarsju](https://avatars.githubusercontent.com/u/4513623?v=4)](https://github.com/ivarsju "ivarsju (8 commits)")[![uldisn](https://avatars.githubusercontent.com/u/3525344?v=4)](https://github.com/uldisn "uldisn (8 commits)")[![nizsheanez](https://avatars.githubusercontent.com/u/686798?v=4)](https://github.com/nizsheanez "nizsheanez (1 commits)")

---

Tags

yii

### Embed Badge

![Health badge](/badges/dbrisinajumi-yeeki/health.svg)

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

###  Alternatives

[yiisoft/yii

Yii Web Programming Framework

4.8k5.6M262](/packages/yiisoft-yii)[yiisoft/yii2-queue

Yii2 Queue Extension which supports queues based on DB, Redis, RabbitMQ, Beanstalk, SQS, and Gearman

1.1k10.4M155](/packages/yiisoft-yii2-queue)[omnilight/yii2-scheduling

Scheduling extension for Yii2 framework

3181.0M7](/packages/omnilight-yii2-scheduling)[yiisoft/yii2-coding-standards

Yii PHP Framework Version 2 - Coding standard tools

1831.0M165](/packages/yiisoft-yii2-coding-standards)[yiisoft/db

Database abstraction layer and query builder

187468.4k30](/packages/yiisoft-db)[yiisoft/arrays

Yii Array Helper

562.0M56](/packages/yiisoft-arrays)

PHPackages © 2026

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