Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoft/TypeScript-wiki
A repository to make changes to the TypeScript Wiki on GitHub
https://github.com/microsoft/TypeScript-wiki
Last synced: 12 days ago
JSON representation
A repository to make changes to the TypeScript Wiki on GitHub
- Host: GitHub
- URL: https://github.com/microsoft/TypeScript-wiki
- Owner: microsoft
- License: cc-by-4.0
- Created: 2015-01-22T23:52:38.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T15:35:28.000Z (17 days ago)
- Last Synced: 2024-10-29T15:23:48.559Z (13 days ago)
- Language: JavaScript
- Homepage: https://github.com/Microsoft/TypeScript/wiki
- Size: 5.34 MB
- Stars: 692
- Watchers: 84
- Forks: 308
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing-to-TypeScript.md
- License: LICENSE
- Security: SECURITY.md
- Roadmap: Roadmap.md
Awesome Lists containing this project
- awesome-list - TypeScript-wiki
README
## The TypeScript wiki
> This repo is a mirror of [the TypeScript wiki](https://github.com/Microsoft/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](.github/workflows/sync.yml), and [another](https://github.com/microsoft/TypeScript/blob/main/.github/workflows/sync-wiki.yml) in the TS repo, and the main work is done by a [`sync` script](.github/workflows/sync).
The wiki root is [Home.md](./Home.md).
You can run this locally if you have ruby installed via:
```sh
# 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:
```sh
# 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
```diff
- 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]:
```
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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) 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](https://creativecommons.org/licenses/by/4.0/legalcode), see 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 [LICENSE-CODE](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.