{"id":47621448,"url":"https://github.com/cakephp/docs-skeleton","last_synced_at":"2026-04-01T22:15:04.500Z","repository":{"id":318159050,"uuid":"1070165586","full_name":"cakephp/docs-skeleton","owner":"cakephp","description":"A Vitepress skeleton tailored for CakePHP branded documentation projects","archived":false,"fork":false,"pushed_at":"2026-02-22T21:16:34.000Z","size":201,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-23T01:07:06.096Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/cakephp.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-05T12:01:40.000Z","updated_at":"2026-02-15T17:24:16.000Z","dependencies_parsed_at":"2025-10-05T15:07:22.708Z","dependency_job_id":"2bf64a81-b395-4390-98bf-77d361edfe82","html_url":"https://github.com/cakephp/docs-skeleton","commit_stats":null,"previous_names":["cakephp/cakephp-docs-skeleton","cakephp/docs-skeleton"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cakephp/docs-skeleton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cakephp","download_url":"https://codeload.github.com/cakephp/docs-skeleton/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs-skeleton/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31292637,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T21:15:39.731Z","status":"ssl_error","status_checked_at":"2026-04-01T21:15:34.046Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-04-01T22:15:03.429Z","updated_at":"2026-04-01T22:15:04.490Z","avatar_url":"https://github.com/cakephp.png","language":"JavaScript","readme":"# CakePHP Documentation Skeleton\n\nA [VitePress](https://vitepress.dev/) based documentation skeleton for creating CakePHP branded documentation sites.\n\n## Features\n\n- 🎨 CakePHP branded theme and styling\n- ⚙️ Easy configuration overrides\n\n## Getting Started\n\n### Installation\n\n```bash\nnpm install\n```\n\n### Development\n\nStart the development server:\n\n```bash\nnpm run docs:dev\n```\n\nThe documentation will be available at `http://localhost:5173`\n\n### Building for Production\n\nBuild the static site:\n\n```bash\nnpm run docs:build\n```\n\nPreview the production build:\n\n```bash\nnpm run docs:preview\n```\n\n## Configuration\n\n### Default Configuration\n\nThe default VitePress configuration is located in `.vitepress/config.js`. This file contains all the base settings for your documentation site.\n\nFor detailed information about VitePress configuration options, please refer to the [VitePress Configuration Reference](https://vitepress.dev/reference/site-config).\n\n### Custom Overrides\n\nTo customize the configuration without modifying the core files:\n\n1. Copy `config.default.js` to `config.js` in the project root\n2. Add your configuration overrides to the exported object\n3. Your overrides will be deep merged with the default configuration\n\n**Example** (`config.js`):\n\n```javascript\nexport default {\n  title: 'My Plugin Documentation',\n  themeConfig: {\n    sidebar: {\n      '/': [\n        { text: 'Home', link: '/' },\n        { text: 'Guide', link: '/guide' }\n      ]\n    }\n  }\n}\n```\n\n### Version Banner\n\nYou can display an e.g. \"Outdated Version\" banner on your documentation site by adding the following configuration:\n\n```javascript\nexport default {\n  themeConfig: {\n    versionBanner: {\n      message: 'You are viewing an older version of this documentation.',\n      link: '/latest/',\n      linkText: 'Go to latest docs.'\n    }\n  }\n}\n```\n\n## Writing Documentation\n\n### Content Location\n\nAll markdown documentation files should be placed in the `docs/` directory.\n\n### Text Substitutions\n\nYou can use placeholders in your markdown files that will be automatically replaced with configured values. This is useful for version numbers or other values that need to be updated across multiple files.\n\n**Configuration** (`config.js`):\n\n```javascript\nexport default {\n  substitutions: {\n    '|phpversion|': { value: '8.4', format: 'bold' },\n    '|minphpversion|': { value: '8.1', format: 'italic' },\n    '|myversion|': '1.0.0'  // Simple string without formatting\n  }\n}\n```\n\n**Usage in Markdown**:\n\n```markdown\nThis plugin requires PHP |phpversion| or higher (minimum |minphpversion|).\n```\n\n**Result**: This plugin requires PHP **8.4** or higher (minimum *8.1*).\n\n## Project Structure\n\n```\n.\n├── .vitepress/           # VitePress configuration\n│   ├── config.js         # Main VitePress config (defaults)\n│   ├── utils.js          # Utility functions\n│   ├── theme/            # Custom theme components\n│   └── plugins/          # Markdown-it plugins\n├── docs/                 # Documentation content (markdown files)\n├── config.js             # Your configuration overrides (create from config.default.js)\n└── config.default.js     # Template for configuration overrides\n```\n\n## Linting\n\nLint your configuration and scripts:\n\n```bash\nnpm run lint\n```\n\nAuto-fix linting issues:\n\n```bash\nnpm run lint:fix\n```\n\n## License\n\nLicensed under The MIT License. For full copyright and license information, please see the [LICENSE](LICENSE) file.\n\n## About CakePHP\n\nCakePHP is a rapid development framework for PHP which uses commonly known design patterns like Associative Data Mapping, Front Controller, and MVC. Learn more at [https://cakephp.org](https://cakephp.org)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcakephp%2Fdocs-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcakephp%2Fdocs-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcakephp%2Fdocs-skeleton/lists"}