{"id":19045526,"url":"https://github.com/yoast/developer","last_synced_at":"2025-04-23T23:48:51.511Z","repository":{"id":38458269,"uuid":"229242774","full_name":"Yoast/developer","owner":"Yoast","description":"The Yoast Developer portal based on Docusaurus","archived":false,"fork":false,"pushed_at":"2025-04-16T15:35:49.000Z","size":7858,"stargazers_count":7,"open_issues_count":33,"forks_count":17,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-23T23:48:44.698Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/Yoast.png","metadata":{"files":{"readme":"README.md","changelog":"changelogs/duplicate-post.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-12-20T10:21:59.000Z","updated_at":"2025-04-16T09:54:46.000Z","dependencies_parsed_at":"2024-04-15T09:53:46.292Z","dependency_job_id":null,"html_url":"https://github.com/Yoast/developer","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/Yoast%2Fdeveloper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fdeveloper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fdeveloper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fdeveloper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yoast","download_url":"https://codeload.github.com/Yoast/developer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250535107,"owners_count":21446506,"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-11-08T22:50:30.496Z","updated_at":"2025-04-23T23:48:51.484Z","avatar_url":"https://github.com/Yoast.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yoast Developer docs\n\nThis repository holds all documentation that is hosted on [developer.yoast.com](https://developer.yoast.com).\nAll documentation is written in Markdown and is read by [Docusaurus](https://docusaurus.io) to be presented in a \nuser-friendly manner.\n\n## A few do's and dont's\n\n### Do...\n* ...ensure files always contain a proper Docusaurus header. Otherwise, the file will not properly show up.\n* ...check that files are grouped logically (i.e. a category or feature) to ensure users can easily find information.\n* ...use headings.\n* ...split up large bodies of text in smaller files, if possible.\n* ...test (newly added) links before submitting a PR to ensure we keep 404's at bay.\n* ...Use [admonitions](https://docusaurus.io/docs/markdown-features/admonitions) for tips, highlights and cautionary alerts. \n\n### Don't...\n* ...hesitate to ask for help if something is unclear in how this project should work.\n\n## Contribute\n\nFound a typo? Want to add some missing documentation? Feel free to fork this repository, make your desired changes and \nsubmit a pull-request.\n\n## Installation\n\nAfter cloning this repository navigate to the directory where this repository is located and run:\n\n```\n$ yarn\n```\n\nThat's it! You are ready to use the portal on your local machine.\n\nAfter this, you have the following options:\n\n### Local Development\nTo quickly test docs changes, just run:\n\n```shell\nyarn start\n```\n\nThis command starts a local development server and open up a browser window. Most changes are reflected live without \nhaving to restart the server.\n\n**Please note:** If you don't want to keep reopening a new tab, ensure you run `yarn start --no-open`. You can also \ncombine this command with `BROWSER=\u003cyour preferred browser\u003e` to force Docusaurus to open in a different browser than \nChrome.\n\nIf you want to test a bit more thoroughly, run a full build, and serve that locally.\n\n### Production and development build\nJust run:\n\n```shell\nyarn build\n# And then to test it locally: \nyarn serve\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting \nservice.\n\n**Note:** the build will fail when there are broken internal links, so running this to test before you commit is a good \nidea. \n\n### Search\nSearch relies on this [Docusaurus search local package](https://github.com/easyops-cn/docusaurus-search-local), and only \nworks when you've done a full build as it needs to build a search index. \n\n### Adding redirects\nTo add redirects, add them to the [_redirects](_redirects) file. The pattern used is the Cloudflare pages [redirects \nformat](https://developers.cloudflare.com/pages/platform/redirects/), which includes support for splats and placeholders. \n\n### Deployment\nDeployment is fully automatic and thus requires no configuration or user interaction.\n\n## Contributing to Yoast Developer portal\nHowdy! It's really great that you want to contribute to the Yoast developer portal. The development of the portal takes \nplace on GitHub.\n\nThere are two main ways to contribute:\n1. [Contributing to issues](#contributing-to-issues)\n2. [Contributing to code](#contributing-to-code)\n\n### Contributing to issues\nWe use GitHub to track public changes and improvements to the docs that need to be discussed and completed. Before creating \nan issue, please make sure what you want to raise have not already been mentioned in another one.\n\nPlease be as descriptive and succinct as possible in your issue, and if necessary, to help better understand the issue, \nadd screenshots or video captures.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoast%2Fdeveloper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoast%2Fdeveloper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoast%2Fdeveloper/lists"}