This is the current website for TypeScript. It uses Jekyll for the majority of the work, and uses git-submodules for the playground and the handbook.
Most of the modern work occurs on the v2 branch which is now the default branch on GitHub.
- URLs: production, staging
A live version with the daily build can be found here.
-
Install the latest Ruby and add it to your environment's PATH during setup. Allow the installer to install MSYS2 via
ridk install.- Download Ruby from here.
-
Install Node.js version 10.
- Download Node.js from here
-
Establish your new environment by opening up a new PowerShell/Command Prompt.
-
Fork https://github.com/Microsoft/TypeScript-Website to your own GitHub account
-
Clone https://github.com/[YOUR_ACCOUNT]/TypeScript-Website
-
Run the following from the cloned repository:
gem install bundler bundler install yarn install npm install -g gulp-cli git submodule init git submodule update cd src/play yarn install yarn setup cd ../..
Ensure that you have configured your build environment as explained above. In a shell, navigate to your clone of this repository and run:
gulpYour default web browser should start up and show the built site.
Note: If you want to make changes to the playground, you have a bit of a dance to do. Run ^ then
press save on a file inside both the examples/ subfolder, and the src/play subfolder. The playground
is a submodule, so that'll need a PR to a different repo.
Deployment is automatic:
- Merges to the branch
archiveddeploy to staging. - Pushes to the branch
releasedeploy to production. You can use:git push origin origin/master:release.
To deploy manually, first use these commands to push to staging:
# Creates a ./site folder
gulp publish
# Pushes to a staging
gulp deploy
# Syncs production with staging
sh sync-staging-to-prod.ps1- Ruby: http://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.2.3-x64.exe
- RubyDevKit: http://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe
- Python Installer: https://www.python.org/ftp/python/2.7.10/python-2.7.10.amd64.msi
- Node.js Installer: https://nodejs.org/dist/v5.0.0/node-v5.0.0-x64.msi
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.
Privacy information can be found at https://privacy.microsoft.com/en-us/
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.