Repository files navigation

This repo is a mirror ofthe TypeScript wiki.Changes on either the wiki or this repo are immediately mirrored to the other side.This is done in a GitHub Actionhere, andanother in the TS repo, and the main work is done by async script.

The wiki root isHome.md.

You can run this locally if you have ruby installed via:

# Install the depsgem install gollum# Start the servergollum

Then you can open:http://localhost:4567

Things to remember:

• Gollum is a bit of a nightmare for testing, my current technique is:

  # beforegit branch -b thing_i_am_working_on# to iterate, amend the commit and re-run gollum against that bit of gitgit add.; git commit --amend --no-edit --no-verify; gollum --ref thing_i_am_working_on

• Wikis don't support nesting, so filenames have to get a bit wild

  - compiler/testing/fourslash.md+ compiler-testing-fourslash.md

• You can use a custom link syntax for references to TypeScript code which willbe looked up at deploy time:

  link to [`runFourSlashTest`][0][0]: <src/harness/fourslash.ts - function runFourSlashTest(>

  Will look at the filesrc/harness/fourslash.ts in microsoft/TypeScript tofind the line of codefunction runFourSlashTest and provide a direct linkin the wiki. You can audit them via the scriptnpm run lint.

This project welcomes contributions and suggestions. Most contributions require you to agree to aContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant usthe rights to use your contribution. For details, visithttps://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to providea CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructionsprovided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ orcontactopencode@microsoft.com 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 theCreative Commons Attribution 4.0 International Public License, see theLICENSE file, and grant you a license to any code in the repository under theMIT License, see theLICENSE-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 athttp://go.microsoft.com/fwlink/?LinkID=254653.

Privacy information can be found athttps://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.