README

The TypeScript wiki

This repo is a mirror of the TypeScript wiki. Changes on either the wiki or this repo are immediately mirrored to the other side. This is done in a GitHub Action here, and another in the TS repo, and the main work is done by a sync script.

The wiki root is Home.md.

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

# Install the deps
gem install gollum

# Start the server
gollum

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

Things to remember:

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

  # before
  git branch -b thing_i_am_working_on
  
  # to iterate, amend the commit and re-run gollum against that bit of git
  git 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 will be looked up at deploy time:

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

  Will look at the file src/harness/fourslash.ts in microsoft/TypeScript to find the line of code function runFourSlashTest and provide a direct link in the wiki. You can audit them via the script npm run lint.

Contributing

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 opencode@microsoft.com with any additional questions or comments.

Legal Notices

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.