{"id":13659546,"url":"https://github.com/Zavy86/WikiDocs","last_synced_at":"2025-04-24T15:30:23.652Z","repository":{"id":39500049,"uuid":"163814651","full_name":"Zavy86/WikiDocs","owner":"Zavy86","description":"📗 Just a databaseless markdown flat-file wiki engine","archived":false,"fork":false,"pushed_at":"2025-04-03T06:07:15.000Z","size":15159,"stargazers_count":411,"open_issues_count":24,"forks_count":49,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-22T19:58:57.106Z","etag":null,"topics":["cms","databaseless","flat-file","jquery","markdown","php","wiki","wiki-engine","wysiwyg"],"latest_commit_sha":null,"homepage":"https://www.wikidocs.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zavy86.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/funding.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["Zavy86","leomoon"],"custom":["https://www.paypal.com/paypalme/zavy86"]}},"created_at":"2019-01-02T08:29:50.000Z","updated_at":"2025-04-22T07:20:42.000Z","dependencies_parsed_at":"2024-01-15T14:39:06.327Z","dependency_job_id":"d5bb4f4c-cd8f-4562-9fef-85a753111861","html_url":"https://github.com/Zavy86/WikiDocs","commit_stats":null,"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zavy86%2FWikiDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zavy86%2FWikiDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zavy86%2FWikiDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zavy86%2FWikiDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zavy86","download_url":"https://codeload.github.com/Zavy86/WikiDocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250654052,"owners_count":21465806,"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","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":["cms","databaseless","flat-file","jquery","markdown","php","wiki","wiki-engine","wysiwyg"],"created_at":"2024-08-02T05:01:09.950Z","updated_at":"2025-04-24T15:30:23.645Z","avatar_url":"https://github.com/Zavy86.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Zavy86","https://github.com/sponsors/leomoon","https://www.paypal.com/paypalme/zavy86","https://www.paypal.me/zavy86)_"],"categories":["JavaScript","Wiki"],"sub_categories":["Bookmarking and Link Aggregation - WordPress Plugins"],"readme":"# Wiki|Docs\n\nJust a databaseless markdown flat-file wiki engine.\n\nProject homepage: [https://www.wikidocs.app](https://www.wikidocs.app)\n\n_Please consider supporting this project by making a donation via [PayPal](https://www.paypal.me/zavy86)_\n\n[![Wiki|Docs presentation and contributors recruitment on YouTube](https://www.wikidocs.app/datasets/documents/homepage/cover-side-project-wikidocs-youtube.jpg)](https://youtu.be/x2nVq9RbG54 \"Watch Wiki|Docs presentation and contributors recruitment on YouTube\")\n\n## Features\n- Open source\n- Plain text files\n- No database required\n- Markdown syntax\n- Editor full WYSIWYG\n- Support for math KaTeX\n- Unlimited page revisions\n- Uploading and downloading Attachments\n- Uploading images (also from clipboard)\n- Content can be categorized in namespaces\n- Automatic generated index and sitemap\n- Public and private browsing\n- Syntax highlighting\n- Multi language\n- Dark mode\n- Sitemap\n- and many more...\n\n## Demo\nTry the demo playground at: [http://demo.wikidocs.app](http://demo.wikidocs.app)\n\nAuthentication code is: `demo`\n\n## Setup\n\n### Manual\n[Download](https://github.com/Zavy86/wikidocs/releases) the lastest release or clone the repository with `git clone https://github.com/Zavy86/wikidocs.git`\n\n### Docker\nThere is a [Docker image](https://hub.docker.com/repository/docker/zavy86/wikidocs) that sets up Wiki|Docs with Apache2 and PHP automatically.\n\n#### Quick run\n```\ndocker run -d -p 80:80 zavy86/wikidocs\n```\n\n#### Additional settings\n```\ndocker run --name wikidocs -d -p 80:80 -v /path/to/local/wikidocs/datasets/or/volume:/datasets -e PUID=1000 -e PGID=1000 zavy86/wikidocs\n```\n\n#### With Docker Compose\n```\nversion: '3'\n\nservices:\n  wikidocs:\n    image: zavy86/wikidocs\n    environment:\n      - PUID=1000\n      - PGID=1000\n    ports:\n      - 80:80\n    volumes:\n      - /path/to/local/wikidocs/datasets/or/volume:/datasets\n```\n\n## Apache Configuration\n\n### Automatic\n- The `setup.php` script will automatically create both `datasets/config.inc.php` and `.htaccess` files\n\n### Manual\n- Copy the configuration sample file `cp config.sample.inc.php datasets/config.inc.php`\n- Edit the configuration file `nano datasets/config.inc.php`\n- Create the `.htaccess` file like this:\n```\n\u003cIfModule mod_rewrite.c\u003e\n\tRewriteEngine On\n\tRewriteBase /\n\tRewriteCond %{REQUEST_URI} \\.md$ [NC]\n\tRewriteRule ^.*$ / [R=301,L]\n\tRewriteCond %{REQUEST_FILENAME} !-f\n\tRewriteRule ^(.*)$ index.php?doc=$1 [NC,L,QSA]\n\u003c/IfModule\u003e\n```\n- Make sure that RewriteBase is the same as the PATH in the configuration file included trailing slashes\n\n## Nginx Configuration\n\n### Manual\n- Use this as Nginx configuration for WikiDocs:\n```\nlocation ~* \\.(css|js|jpg|jpeg|png|gif|ico|svg)$ {\n  try_files $uri =404;\n  add_header Cache-Control \"public, max-age=3600\";\n}\nlocation ~* \\.md$ {\n  return 301 /;\n}\nlocation / {\n  if (!-e $request_filename){\n    rewrite ^/(.*)$ /index.php?doc=$1 last;\n  }\n  try_files $uri $uri/ =404;\n}\n```\n\n- Copy the configuration sample file `cp config.sample.inc.php datasets/config.inc.php`\n- Edit the configuration file `nano datasets/config.inc.php`\n\n## Customization\n\nYou can customize the default template by creating the file `styles/styles-custom.css`.\n\n\n\n## Developers\n\n### Creator\n**Manuel Zavatta**\n- [WebSite](http://www.zavy.im)\n- [GitHub](https://github.com/Zavy86)\n- [YouTube](https://www.youtube.com/@zavy86)\n- [Contacts](mailto://manuel.zavatta@gmail.com)\n\n### Contributors\n- [Amin Persia](https://github.com/leomoon)\n- [Alex Meyer](https://github.com/reyemxela)\n- [Micha](https://github.com/serial)\n- [Bo Allen](https://github.com/bitwisecreative)\n- [Jv3ga](https://github.com/jv3ga)\n- [Sam](https://github.com/sam-6174)\n- [kevwkev](https://github.com/kevwkev)\n- [Сергей Ворон](https://github.com/vorons)\n- [Nicolas Prenveille](https://github.com/nicolas35380)\n- [Antonio Rodrigues](https://github.com/aaadonai)\n- [Miguel Renato](https://github.com/MiguelRenato)\n- [Alain Martini](https://github.com/inalto)\n- [Davide Visentin](https://github.com/dvisentin-freelance)\n- [Christian Weber](https://github.com/pce-consulting)\n- [Petr Husák](https://github.com/petrhusak)\n- [Oliver Lehmann](https://github.com/OlliL)\n\n## License\nCode released under the MIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZavy86%2FWikiDocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FZavy86%2FWikiDocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZavy86%2FWikiDocs/lists"}