void/VOID_USEFUL_LINKS.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

38 lines
2.1 KiB
Markdown
Raw Normal View History

2024-09-10 21:03:04 -07:00
# Useful links
The Void team put together this list of links to get up and running with VSCode's sourcecode. We hope it's helpful!
2024-09-10 21:03:04 -07:00
## Contributing
2024-12-12 14:37:54 -08:00
- [How VSCode's sourcecode is organized](https://github.com/microsoft/vscode/wiki/Source-Code-Organization) - this explains where the entry point files are, what `browser/` and `common/` mean, etc. This is the most important read on this whole list! We recommend reading the whole thing.
2024-09-10 21:03:04 -07:00
2024-12-12 14:37:54 -08:00
- [Built-in VSCode Styles](https://code.visualstudio.com/api/references/theme-color) - CSS variables that are built into VSCode. Use `var(--vscode-{theme but replacing . with -})`. You can also see the [Webview Theming Guide](https://code.visualstudio.com/api/extension-guides/webview#theming-webview-content).
2024-09-10 22:49:30 -07:00
2024-12-12 16:42:48 -08:00
## Beginners / Getting started
- [VSCode UI guide](https://code.visualstudio.com/docs/getstarted/userinterface) - covers auxbar, panels, etc.
- [UX guide](https://code.visualstudio.com/api/ux-guidelines/overview) - covers Containers, Views, Items, etc.
2024-12-12 14:37:54 -08:00
## Misc
- [Every command](https://code.visualstudio.com/api/references/commands) built-in to VSCode - not used often, but here for reference.
2024-09-10 21:03:04 -07:00
2024-09-10 22:47:13 -07:00
## VSCode's Extension API
2024-09-10 21:03:04 -07:00
2024-11-26 16:39:01 -08:00
Void is no longer an extension, so these links are no longer required, but they might be useful if we ever build an extension again.
2024-09-10 22:55:23 -07:00
2024-09-10 22:47:13 -07:00
- [Files you need in an extension](https://code.visualstudio.com/api/get-started/extension-anatomy).
2024-09-10 21:03:04 -07:00
2024-09-10 22:57:00 -07:00
- [An extension's `package.json` schema](https://code.visualstudio.com/api/references/extension-manifest).
2024-09-10 21:03:04 -07:00
2024-09-10 22:52:13 -07:00
- ["Contributes" Guide](https://code.visualstudio.com/api/references/contribution-points) - the `"contributes"` part of `package.json` is how an extension mounts.
2024-09-10 21:03:04 -07:00
2024-09-10 22:52:39 -07:00
- [The Full VSCode Extension API](https://code.visualstudio.com/api/references/vscode-api) - look on the right side for organization. The [bottom](https://code.visualstudio.com/api/references/vscode-api#api-patterns) of the page is easy to miss but is useful - cancellation tokens, events, disposables.
2024-09-10 21:03:04 -07:00
2024-09-15 19:07:46 -07:00
- [Activation events](https://code.visualstudio.com/api/references/activation-events) you can define in `package.json` (not the most useful)
2024-09-10 21:03:04 -07:00