{"id":18561212,"url":"https://github.com/apostrophecms/docs","last_synced_at":"2025-10-03T12:23:12.561Z","repository":{"id":37585300,"uuid":"309096142","full_name":"apostrophecms/docs","owner":"apostrophecms","description":"Comprehensive documentation for ApostropheCMS, including usage guides, developer tutorials, API references, and best practices.","archived":false,"fork":false,"pushed_at":"2025-04-07T18:08:03.000Z","size":54133,"stargazers_count":5,"open_issues_count":8,"forks_count":13,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T19:23:50.584Z","etag":null,"topics":["documentation","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://docs.apostrophecms.org/","language":"Shell","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/apostrophecms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-11-01T12:57:36.000Z","updated_at":"2025-04-07T18:05:41.000Z","dependencies_parsed_at":"2023-02-17T08:00:40.855Z","dependency_job_id":"98d1e721-08c8-4c1b-89e5-707d43bc1024","html_url":"https://github.com/apostrophecms/docs","commit_stats":null,"previous_names":["apostrophecms/a3-docs"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apostrophecms","download_url":"https://codeload.github.com/apostrophecms/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248144209,"owners_count":21054886,"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":["documentation","hacktoberfest"],"created_at":"2024-11-06T22:06:12.988Z","updated_at":"2025-10-03T12:23:12.549Z","avatar_url":"https://github.com/apostrophecms.png","language":"Shell","readme":"# How to update Apostrophe CMS documentation\n\n\nThis project contains [the documentation site](https://docs.apostrophecms.org/)\nfor [ApostropheCMS](https://apostrophecms.com).\n\nYou don't need to read this page to read the documentation! This page\nis about *contributing to* the documentation.\n\n## Building the docs\n\n### 1. Setup\n\nClone the repo.\n\n```bash\n$ git clone https://github.com/apostrophecms/docs.git\n$ cd docs\n```\n\nNext, install the dependencies for the main Vitepress documentation build.\n\n```\nnpm install\n```\n\nNow you can build the docs with:\n\n```\nnpm run dev\n```\n\nFor testing, or\n\n```\nnpm run build\n```\nfollowed by\n```\nnpm run preview\n```\nNote that the build version is *less* tolerant of errors in your markdown files, so it is important to do this step before deployment. \n\nFor deployment (requires credentials of course), you can select to deploy to staging, production, or both. For deployment to staging only, for example, you would use\n\n```\nnpm run deploy-staging\n```\nFor deployment to production only (unusual):\n\n```\nnpm run deploy-production\n```\n\nFor deployment to both, \n\n```\nnpm run deploy-all\n```\n\n### 2. Editing content\n\nSee the `docs` subdirectory for Markdown files.\n\nImages should be added to `images/assets` and embedded with relative paths, like this:\n\n```\n![](../../../images/assets/user-menu.png)\n```\n\n**If you add a new top level page,** you will need to edit `docs/.vitepress/config.js`.  Otherwise it will not appear in the navigation.\n\n### 3. Linking to other pages\n\nWhen creating links in the body of a documentation page that point to another\npage of documentation, either make sure the link is relative and pointing to the\n`.md` extension OR use the file path starting starting after the `docs`\ndirectory. So you would link to `docs/devops/email.md` with\n`[link text](/devops/email.md)`.\n\n### 4. Submit for review\n\nFirst, make sure you've built and reviewed your documentation locally using build and preview (`npm run build \u0026\u0026 npm run preview`) and\nconfirmed that your links work properly. Submit your changes as a pull request\non the [docs](https://github.com/apostrophecms/docs/)\nrepository. Please include as much context for the change as is reasonable in\nthe PR description.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapostrophecms%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapostrophecms%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapostrophecms%2Fdocs/lists"}