{"id":14966528,"url":"https://github.com/samdark/yeeki","last_synced_at":"2025-09-21T01:15:21.967Z","repository":{"id":2527854,"uuid":"3504264","full_name":"samdark/Yeeki","owner":"samdark","description":"Yii 1.1-based wiki","archived":false,"fork":false,"pushed_at":"2015-01-04T16:36:08.000Z","size":254,"stargazers_count":95,"open_issues_count":10,"forks_count":22,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-07T07:42:02.922Z","etag":null,"topics":["wiki","yii"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samdark.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-02-21T13:54:58.000Z","updated_at":"2024-06-25T11:21:07.000Z","dependencies_parsed_at":"2022-08-25T07:50:28.695Z","dependency_job_id":null,"html_url":"https://github.com/samdark/Yeeki","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/samdark/Yeeki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samdark%2FYeeki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samdark%2FYeeki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samdark%2FYeeki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samdark%2FYeeki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samdark","download_url":"https://codeload.github.com/samdark/Yeeki/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samdark%2FYeeki/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276181501,"owners_count":25598897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-20T02:00:10.207Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wiki","yii"],"created_at":"2024-09-24T13:36:32.405Z","updated_at":"2025-09-21T01:15:21.926Z","avatar_url":"https://github.com/samdark.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Yeeki\n=====\n\nYeeki is a flexible wiki engine that can be used either as a standalone application\nor as an [Yii framework](http://www.yiiframework.com/) module.\n\nBy default it uses [markdown](http://michelf.com/projects/php-markdown/extra/) syntax with\naddition of wiki-links.\n\nImplemented features\n--------------------\n\n- Unicode support\n- namespaces\n- page index\n- revision history\n- ability to view specific revision\n- ability to enter change summary for edit and view it at revision history page\n- revision diff\n- multiple markup dialects support (only markdown provided out of the box)\n- cross-linking with [[wiki-links]]\n- theming support\n- i18n support\n\nRequirements\n------------\n\nCurrently in order to use Yeeki you need MySQL with InnoDB engine enabled. In the\nfuture it is planned to allow using it with MyISAM and PostgreSQL.\n\nAlso server should be able to run [Yii framework](http://www.yiiframework.com/).\n\nUsing Yeeki as an application\n-----------------------------\n\nCurrently you need to perform steps listed below. In the future versions all these\nwill be covered by automated installer.\n\n1. Unpack contents of release archive.\n2. Point your webserver docroot to `www`.\n3. Make sure webserver have write permissions for `www/assets` and `app/runtime`.\n3. Create a database with `utf8` encoding and `utf8_general_ci` collation.\n4. Provide proper database credentials in `app/config/db.php`.\n5. Run `install.php` from a web browser.\n\nUsing Yeeki as a module\n----------------------\n\n- Copy `app/modules/wiki` to your application directory.\n- Using `yiic` apply migrations with the following command:\n\n~~~\nyiic migrate --migrationPath=application.modules.wiki.migrations --migrationTable=wiki_migration\n~~~\n\n- Add `wiki` module to your web application config (usually it is `protected/config/main.php`):\n\n```php\nreturn array(\n\t'basePath'=\u003edirname(__FILE__).DIRECTORY_SEPARATOR.'..',\n\t'name'=\u003e'My cool application',\n\n\t// add the following:\n\t'modules' =\u003e array(\n\t\t'wiki' =\u003e array(\n\n\t\t),\n\t),\n\n\t// …\n```\n\n- Add `cache` component to your application configuration:\n\n```php\nreturn array(\n  // ...\n  'components' =\u003e array(\n    'cache' =\u003e array(\n       'class' =\u003e 'CFileCache',\n    ),\n  ),\n);\n```\n\n### Implementing data interfaces and configuring module\n\nIn order to use wiki in your application you should implement some simple interfaces\nand configure module pointing to implementations. If you're using standard `Yii::app()-\u003euser`\nand standard RBAC then the only mandatory interface to implement is `IWikiUser`.\nYou can find sample implementation in `app/components/WikiUser.php`. After\nimplementing it you need to configure the module:\n\n~~~\n'modules' =\u003e array(\n\t'wiki' =\u003e array(\n\t\t'userAdapter' =\u003e array(\n\t\t\t'class' =\u003e 'WikiUser',\n\t\t),\n\t),\n),\n~~~\n\nSee also `IWikiAuth`, `IWikiSearch`.\n\n\nTheming Yeeki\n-------------\n\nYou can use standard Yii theming feature to theme Yeeki. For details please\nrefer to [the definitive guide](http://www.yiiframework.com/doc/guide/1.1/en/topics.theming).\n\nLicense\n-------\n\nYeeki is licensed under New BSD license. That allows proprietary use, and for\nthe software released under the license to be incorporated into proprietary\nproducts. Works based on the material may be released under a proprietary license\nor as closed source software. It is possible for something to be distributed\nwith the BSD License and some other license to apply as well.\n\nCredits\n-------\n\n- Initial code and ideas: Alexander Makarov, @samdark.\n- Features contribution: Mark Bryk, @mbryk.\n\nThanks\n------\n\n- [CleverTech](http://clevertech.biz/) for supporting this OpenSource project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamdark%2Fyeeki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamdark%2Fyeeki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamdark%2Fyeeki/lists"}