{"id":14987312,"url":"https://github.com/michalsn/codeigniter-markdown-pages","last_synced_at":"2025-08-20T08:05:20.596Z","repository":{"id":207028336,"uuid":"717133792","full_name":"michalsn/codeigniter-markdown-pages","owner":"michalsn","description":"Easily work with markdown based files in CodeIgniter 4","archived":false,"fork":false,"pushed_at":"2025-01-02T07:11:00.000Z","size":693,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-04-11T23:52:44.767Z","etag":null,"topics":["codeigniter","codeigniter4","markdown","php","php81"],"latest_commit_sha":null,"homepage":"https://michalsn.github.io/codeigniter-markdown-pages/","language":"PHP","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/michalsn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-11-10T16:26:20.000Z","updated_at":"2025-03-01T20:04:19.000Z","dependencies_parsed_at":"2023-12-29T12:39:54.945Z","dependency_job_id":"1aa3ac4e-51bb-485a-b55a-d98db6ab3812","html_url":"https://github.com/michalsn/codeigniter-markdown-pages","commit_stats":{"total_commits":33,"total_committers":2,"mean_commits":16.5,"dds":"0.030303030303030276","last_synced_commit":"7a6bc034106203e530aa46cc0a499b4bf2850ce0"},"previous_names":["michalsn/codeigniter-markdown-pages"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michalsn%2Fcodeigniter-markdown-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michalsn%2Fcodeigniter-markdown-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michalsn%2Fcodeigniter-markdown-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michalsn%2Fcodeigniter-markdown-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michalsn","download_url":"https://codeload.github.com/michalsn/codeigniter-markdown-pages/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497851,"owners_count":21113984,"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":["codeigniter","codeigniter4","markdown","php","php81"],"created_at":"2024-09-24T14:14:25.733Z","updated_at":"2025-04-11T23:52:50.886Z","avatar_url":"https://github.com/michalsn.png","language":"PHP","readme":"# CodeIgniter Markdown Pages\n\nMarkdown based pages for the CodeIgniter 4 framework.\n\n[![PHPUnit](https://github.com/michalsn/codeigniter-markdown-pages/actions/workflows/phpunit.yml/badge.svg)](https://github.com/michalsn/codeigniter-markdown-pages/actions/workflows/phpunit.yml)\n[![PHPStan](https://github.com/michalsn/codeigniter-markdown-pages/actions/workflows/phpstan.yml/badge.svg)](https://github.com/michalsn/codeigniter-markdown-pages/actions/workflows/phpstan.yml)\n[![Deptrac](https://github.com/michalsn/codeigniter-markdown-pages/actions/workflows/deptrac.yml/badge.svg)](https://github.com/michalsn/codeigniter-markdown-pages/actions/workflows/deptrac.yml)\n[![Coverage Status](https://coveralls.io/repos/github/michalsn/codeigniter-markdown-pages/badge.svg?branch=develop)](https://coveralls.io/github/michalsn/codeigniter-markdown-pages?branch=develop)\n\n![PHP](https://img.shields.io/badge/PHP-%5E8.1-blue)\n![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)\n\n## Installation\n\n    composer require michalsn/codeigniter-markdown-pages\n\n## Basic usage\n\nTo easily demonstrate how the things are working we will assume for a moment that this is our folder structure.\n\n```bash\n├── app\n├── content\n│   ├── 1_quick-start\n│   │   ├── 1_installation.md\n│   │   ├── 2_database-migration.md\n│   │   ├── what-next.md\n│   │   └── subfolder\n│   │       └── one-file.md\n│   └── first-steps\n│       ├── available-methods.md\n│       └── how-to-use-this.md\n├── public\n├── tests\n├── vendor\n└── writable\n```\n\nNow we have to initialize Markdown Pages with our folder:\n\n```php\n$markdownPages = services('markdownpages', ROOTPATH . 'content');\n\n$dir = $markdownPages-\u003edirs()-\u003efirst();\n\necho $dir-\u003egetName()\n// prints: Quick Start\n\necho $dir-\u003egetSlug()\n// prints: quick-start\n\nforeach($dir-\u003egetFiles()-\u003eitems() as $file) {\n    echo $file-\u003egetName();\n    // prints: Installation\n\n    echo $file-\u003egetSlug();\n    // prints: installation\n\n    echo $file-\u003egetPath();\n    // prints: quick-start/installation\n\n    echo $file-\u003eparse()-\u003egetContent();\n    // prints: parsed markdown from a file\n\n    echo $file-\u003eparse()-\u003egetMeta();\n    // prints: parsed YAML as key -\u003e value\n}\n```\n\nWe use [Collection](https://github.com/lonnieezell/myth-collection) class pretty much everywhere so please get familiar with it to use this package comfortably.\n\n## Docs\n\nhttps://michalsn.github.io/codeigniter-markdown-pages/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichalsn%2Fcodeigniter-markdown-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichalsn%2Fcodeigniter-markdown-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichalsn%2Fcodeigniter-markdown-pages/lists"}