{"id":14070270,"url":"https://github.com/microsoft/rushstack-websites","last_synced_at":"2025-04-16T20:57:22.208Z","repository":{"id":37855439,"uuid":"423710021","full_name":"microsoft/rushstack-websites","owner":"microsoft","description":"Doc content for the Rush Stack websites.","archived":false,"fork":false,"pushed_at":"2025-04-16T01:24:55.000Z","size":8200,"stargazers_count":31,"open_issues_count":47,"forks_count":75,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-16T02:35:03.451Z","etag":null,"topics":["rushstack"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-02T04:48:12.000Z","updated_at":"2025-04-04T20:22:33.000Z","dependencies_parsed_at":"2023-02-18T13:16:15.878Z","dependency_job_id":"f76670ba-7901-4728-9f98-0e6c77fc6b4e","html_url":"https://github.com/microsoft/rushstack-websites","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/microsoft%2Frushstack-websites","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Frushstack-websites/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Frushstack-websites/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Frushstack-websites/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/rushstack-websites/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249275966,"owners_count":21242285,"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":["rushstack"],"created_at":"2024-08-13T07:07:37.060Z","updated_at":"2025-04-16T20:57:22.161Z","avatar_url":"https://github.com/microsoft.png","language":"TypeScript","readme":"# Rush Stack Websites\n\n\u003c!-- prettier-ignore --\u003e\nMain CI | Latest Deployment\n------- | -----------------\n[![Main CI](https://dev.azure.com/RushStack/GitHubProjects/_apis/build/status/rushstack-websites/RushStack%20Websites%20Deploy?branchName=main)](https://dev.azure.com/RushStack/GitHubProjects/_build/latest?definitionId=27\u0026branchName=main) | [![Latest Deployment](https://dev.azure.com/RushStack/GitHubProjects/_apis/build/status/rushstack-websites/RushStack%20Websites%20Deploy?branchName=main)](https://dev.azure.com/RushStack/GitHubProjects/_build/latest?definitionId=28\u0026branchName=main)\n\nThe following websites are maintained in this monorepo:\n\n- https://api-extractor.com\n- https://api.rushstack.io\n- https://lfx.rushstack.io\n- https://heft.rushstack.io/\n- https://rushjs.io\n- https://rushstack.io\n- https://tsdoc.org\n\n## Targets\n\nThe Docusaurus websites in this monorepo support a concept called \"target\", which describes the environment\nsites are being built for. There are 3 possible targets:\n\n### \"local\"\n\nThe `local` target is intended for use when a Docusaurus development server is running locally. This\ntarget will automatically be selected if you run `rushx start` in any of the website projects.\n\nYou can also force this target by setting the environment variable `TARGET=local`.\n\n### \"fork\"\n\nThe `fork` target is intended for use when you are building static Docusaurus sites for deployment,\nbut you'll be deploying them to GitHub Pages on your fork of the `rushstack-websites` project. This is\nuseful for deploying demo sites to share with others, to test on phones and tablets, etc. This target\nwill automatically be selected if you run a production build (`rushx build`) of a website project and\nyou have cloned a _fork_ of the `rushstack-websites` project.\n\nYou can also force this target by setting the environment variable `TARGET=fork`.\n\n### \"prod\"\n\nThe `prod` target is intended for use when you will be deploying a website project to GitHub Pages\nin its live production repo. Typically this target is only used by a CI pipeline, and it is automatically\nselected if you run a production build on a clone of the `microsoft/rushstack-websites` repo.\n\nYou can also force this target by setting the environment variable `TARGET=prod`.\n\n## Deploying a fork\n\nTo facilitate testing of multi-site changes, you can opt to build and deploy all of the website projects\nat once from a fork of `rushstack-websites`. To do so, first make sure you've forked the project\nand cloned your fork locally, and then run:\n\n```bash\nrush install\nrush build\nGIT_USER=\u003cyour-git-username\u003e rush deploy-fork\n```\n\nThe commands above will automatically build all of the supported websites with `TARGET=fork`, then deploy\nthem in a group to the `gh-pages` branch of your forked repo. You can then access these sites via individual\nsite paths, for example:\n\n```text\nhttps://\u003cyour-git-username\u003e.github.io/rushstack-websites/rushstack.io/\n```\n\nCross-site links between the different sites will automatically be linked up to navigate to your deployed\nversions of those sites.\n\n## Deploying to production\n\nThe production Rushstack websites are deployed periodically by the maintainers using an Azure DevOps pipeline. Check the badge at the top of this README for the latest status and deployment history.\n\n# Contributing\n\nThis project welcomes contributions and suggestions. Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.microsoft.com.\n\nWhen you submit a pull request, a CLA-bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n# Legal Notices\n\nMicrosoft and any contributors grant you a license to the Microsoft documentation and other content\nin this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),\nsee the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the\n[LICENSE-CODE](LICENSE-CODE) file.\n\nMicrosoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation\nmay be either trademarks or registered trademarks of Microsoft in the United States and/or other countries.\nThe licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks.\nMicrosoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.\n\nPrivacy information can be found at https://privacy.microsoft.com/en-us/\n\nMicrosoft and any contributors reserve all others rights, whether under their respective copyrights, patents,\nor trademarks, whether by implication, estoppel or otherwise.\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Frushstack-websites","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Frushstack-websites","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Frushstack-websites/lists"}