{"id":23380622,"url":"https://github.com/agility/agilitycms-documentation-site","last_synced_at":"2025-04-08T07:43:12.979Z","repository":{"id":43060031,"uuid":"398307242","full_name":"agility/agilitycms-documentation-site","owner":"agility","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-03T14:05:35.000Z","size":1035,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-03T17:24:33.778Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://agilitycms-documentation-site.vercel.app/docs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/agility.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-08-20T14:42:45.000Z","updated_at":"2024-05-29T21:24:56.000Z","dependencies_parsed_at":"2024-05-03T15:31:31.638Z","dependency_job_id":"34c6254a-0bd3-4660-8282-c18779979397","html_url":"https://github.com/agility/agilitycms-documentation-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagilitycms-documentation-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagilitycms-documentation-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagilitycms-documentation-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagilitycms-documentation-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agility","download_url":"https://codeload.github.com/agility/agilitycms-documentation-site/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247801198,"owners_count":20998331,"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":[],"created_at":"2024-12-21T20:17:05.994Z","updated_at":"2025-04-08T07:43:12.959Z","avatar_url":"https://github.com/agility.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agility Documentation Site\nThis is the source code for the [Agility Documentation](https://agilitycms.com/docs) site.\n\n[Demo](https://agilitycms.com/docs)\n\n[New to Agility CMS? Sign up for a FREE account](https://agilitycms.com/free)\n\n## About This Site\n\n- Uses our [`@agility/next`](https://github.com/agility/agility-next) package to make getting started with Agility and Next.js easy\n- Uses the `getStaticProps` function from Next.js to allow for full SSG (Static Site Generation)\n- Supports [`next/image`](https://nextjs.org/docs/api-reference/next/image) for image optimization\n- Supports full [Page Management](https://help.agilitycms.com/hc/en-us/articles/360055805831)\n- Supports Preview Mode\n- Uses `revalidate` tag with Vercel to enable [ISR (Incremental Static Regeneration)](https://nextjs.org/docs/basic-features/data-fetching#incremental-static-regeneration) builds\n- Provides a functional structure that dynamically routes each page based on the request, loads a Page Templates dynamically, and also dynamically loads and renders appropriate Agility CMS Page Modules (as React components)\n\n### Tailwind CSS\n\n Uses [Tailwind CSS](https://tailwindcss.com/), a simple and lightweight utility-first CSS framework packed with classes that can be composed to build any design, directly in your markup.\n\nIt also comes equipped with [Autoprefixer](https://www.npmjs.com/package/autoprefixer), a plugin which use the data based on current browser popularity and property support to apply CSS prefixes for you.\n\n### TypeScript\n\nSupports [TypeScript](https://nextjs.org/docs/basic-features/typescript). Not currently being used, but simply rename your files with a `.ts` extension to start taking advantage of Typescript concepts such as types and interfaces to help describe your data.\n\n## Getting Started\n\nTo start development on this site:\n\n1. Clone this repository\n2. Run `yarn install`\n3. Rename the `.env.local.template` file to `.env.local`\n4. Retrieve your `GUID`, `API Keys (Preview/Fetch)`, and `Security Key` from Agility by going to [Settings \u003e API Keys](https://manager.agilitycms.com/settings/apikeys).\n\n[How to Retrieve your GUID and API Keys from Agility](https://help.agilitycms.com/hc/en-us/articles/360031919212-Retrieving-your-API-Key-s-Guid-and-API-URL-)\n\n## Running the Site Locally\n\n### Development Mode\n\nWhen running your site in `development` mode, you will see the latest content in real-time from the CMS.\n\n#### yarn\n\n1. `yarn install`\n2. `yarn dev`\n\n\n### Production Mode\n\nWhen running your site in `production` mode, you will see the published from the CMS.\n\n#### yarn\n\n1. `yarn build`\n2. `yarn start`\n\n## Accessing Content\nContent get's passed to your Agility Page Modules as `props`, but you can also use the built in API to access. The API uses the [REST API](https://agilitydocs.netlify.app/agility-content-fetch-js-sdk/).\ns\n## Notes\n\n### How to Register Page Modules\n\n1. To create a new Page Module, create a new React component within the `/components/agility-pageModules` directory.\n2. All of the Page Modules that are being used within the site need to be imported into the `index` file within the `/components/agility-pageModules` directory and added to the `allModules` array:\n\n```\nimport RichTextArea from \"./RichTextArea\";\nimport FeaturedPost from \"./FeaturedPost\";\nimport PostsListing from \"./PostsListing\";\nimport PostDetails from \"./PostDetails\";\nimport Heading from \"./Heading\";\nimport TextBlockWithImage from \"./TextBlockWithImage\";\n\nconst allModules = [\n  { name: \"TextBlockWithImage\", module: TextBlockWithImage },\n  { name: \"Heading\", module: Heading },\n  { name: \"FeaturedPost\", module: FeaturedPost },\n  { name: \"PostsListing\", module: PostsListing },\n  { name: \"PostDetails\", module: PostDetails },\n  { name: \"RichTextArea\", module: RichTextArea },\n];\n```\n\n### How to Register Page Templates\n\n1. To create a new Page Template, create a new React component within the `/components/agility-pageTemplates` directory.\n2. All of the Page Template that are being used within the site need to be imported into the `index` file within the `/components/agility-pageTemplates` directory and added to the `allTemplates` array:\n\n```\nimport MainTemplate from \"./MainTemplate\";\n\nconst allTemplates = [\n  { name: \"MainTemplate\", template: MainTemplate }\n];\n```\n\n### How to Properly Link to an Internal Page\n\nTo link to internal pages, use the `next/link` component.\n\n```\nimport Link from 'next/link';\n\n\u003cLink href=\"/posts\"\u003e\n  \u003ca\u003e{item.fields.title}\u003c/a\u003e\n\u003c/Link\u003e\n```\n\n### How to Preview Content\n\nSince this is a static site, how can editors preview content in real-time as they are making edits within Agility CMS? Vercel supports Previews out of the box! Simply paste the address of your site deployed on Vercel into your Agility Sitemap Configuration (Settings \u003e Sitemaps), and use it as your Preview Deployment.\n\n## Resources\n\n### Agility CMS\n- [Official site](https://agilitycms.com)\n- [Documentation](https://help.agilitycms.com/hc/en-us)\n\n### Next.js\n- [Official site](https://nextjs.org/)\n- [Documentation](https://nextjs.org/docs/getting-started)\n\n### Vercel\n- [Official site](https://vercel.com/)\n\n### Tailwind CSS\n- [Official site](http://tailwindcss.com/)\n- [Documentation](http://tailwindcss.com/docs)\n\n### Community\n- [Official Slack](https://join.slack.com/t/agilitycommunity/shared_invite/enQtNzI2NDc3MzU4Njc2LWI2OTNjZTI3ZGY1NWRiNTYzNmEyNmI0MGZlZTRkYzI3NmRjNzkxYmI5YTZjNTg2ZTk4NGUzNjg5NzY3OWViZGI)\n- [Blog](https://agilitycms.com/resources/posts)\n- [GitHub](https://github.com/agility)\n- [Forums](https://help.agilitycms.com/hc/en-us/community/topics)\n- [Facebook](https://www.facebook.com/AgilityCMS/)\n- [Twitter](https://twitter.com/AgilityCMS)\n\n## Feedback and Questions\nIf you have feedback or questions about this starter, please use the [Github Issues](https://github.com/agility/agilitycms-nextjs-starter/issues) on this repo, join our [Community Slack Channel](https://join.slack.com/t/agilitycommunity/shared_invite/enQtNzI2NDc3MzU4Njc2LWI2OTNjZTI3ZGY1NWRiNTYzNmEyNmI0MGZlZTRkYzI3NmRjNzkxYmI5YTZjNTg2ZTk4NGUzNjg5NzY3OWViZGI) or create a post on the [Agility Developer Community](https://help.agilitycms.com/hc/en-us/community/topics).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagility%2Fagilitycms-documentation-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagility%2Fagilitycms-documentation-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagility%2Fagilitycms-documentation-site/lists"}