mirror of
https://github.com/voideditor/void.git
synced 2025-03-15 17:30:09 +00:00
40 lines
2.2 KiB
Markdown
40 lines
2.2 KiB
Markdown
# 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!
|
|
|
|
For a complete guide on building Void, see [Contributing](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md).
|
|
|
|
## Contributing
|
|
|
|
- [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.
|
|
|
|
- [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 their [Webview theming guide](https://code.visualstudio.com/api/extension-guides/webview#theming-webview-content).
|
|
|
|
## 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.
|
|
|
|
|
|
## Misc
|
|
|
|
- [Every command](https://code.visualstudio.com/api/references/commands) built-in to VSCode - not used often, but here for reference.
|
|
|
|
|
|
## VSCode's Extension API
|
|
|
|
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.
|
|
|
|
- [Files you need in an extension](https://code.visualstudio.com/api/get-started/extension-anatomy).
|
|
|
|
- [An extension's `package.json` schema](https://code.visualstudio.com/api/references/extension-manifest).
|
|
|
|
- ["Contributes" Guide](https://code.visualstudio.com/api/references/contribution-points) - the `"contributes"` part of `package.json` is how an extension mounts.
|
|
|
|
- [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.
|
|
|
|
- [Activation events](https://code.visualstudio.com/api/references/activation-events) you can define in `package.json` (not the most useful).
|
|
|
|
|