Skip to content

Example setups (Julia, remote development, TypeScript) #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 26 commits into from
Feb 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
8f06838
add remote dev setup guide
gwenzek Jul 20, 2020
1c202c3
add Julia dev setup guide.
gwenzek Jul 20, 2020
0c1c228
add link to setups page in guide entry point.
gwenzek Jul 20, 2020
23e4132
format julia.md
gwenzek Jul 20, 2020
88ae807
format remote_dev.md
gwenzek Jul 20, 2020
03ee9a7
rewrite from 1st person to 3rd person
gwenzek Aug 3, 2020
6379342
add to config.js
FichteFoll Feb 2, 2025
e0f692a
minor improvements from FichteFoll
gwenzek Aug 3, 2020
8d81aac
Fix vuepress paths to mirror headers
bkoski Jun 26, 2021
9ae94bb
Add TypeScript example setups page
bkoski Jun 27, 2021
60777bf
Update embedded languages
TerminalFi Feb 2, 2025
1391f4a
Revise ST config path
TerminalFi Feb 2, 2025
0a9b15d
Rename example setups index page
FichteFoll Feb 2, 2025
6039e18
Add line breaks to typescript.md
FichteFoll Feb 2, 2025
4528f38
Make some cleanups to remote_dev.md
FichteFoll Feb 2, 2025
a563046
Fix unclosed tag
FichteFoll Feb 2, 2025
212e90f
Fix example setups reference
FichteFoll Feb 2, 2025
8a66e0b
Fix example setups in config.js
FichteFoll Feb 2, 2025
b93b5db
Update page titles for example setups section
FichteFoll Feb 2, 2025
00b736f
Strip trailing whitespace
FichteFoll Feb 2, 2025
84e70d3
Add a small section to key bindings on how to edit them
FichteFoll Feb 15, 2025
02fb52c
Revise Julia example setup a bit
FichteFoll Feb 15, 2025
07b3264
Revice remote dev example setup a bit
FichteFoll Feb 15, 2025
2f7c62e
Add markdown-it-footnote plugin
FichteFoll Feb 15, 2025
041334a
Revise TypeScript section
FichteFoll Feb 15, 2025
00e76db
Address old review comments in #24
FichteFoll Feb 15, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import markdownItDeflist from 'markdown-it-deflist';
import markdownItFootnote from 'markdown-it-footnote';
import { defineConfig, type HeadConfig } from 'vitepress';

const customHead: HeadConfig[] = [
Expand Down Expand Up @@ -133,6 +134,16 @@ export default defineConfig({
{ text: 'Syntax Definitions', link: '/guide/extensibility/syntaxdefs.md' },
],
},
{
text: 'Example Setups',
link: '/guide/example-setups/',
collapsed: false,
items: [
{ text: 'Julia', link: '/guide/example-setups/julia.md' },
{ text: 'Remove Development', link: '/guide/example-setups/remote_dev.md' },
{ text: 'TypeScript', link: '/guide/example-setups/typescript.md' },
],
},
],
'/reference/': [
{
Expand Down Expand Up @@ -178,6 +189,7 @@ export default defineConfig({
lineNumbers: true,
config: md => {
md.use(markdownItDeflist);
md.use(markdownItFootnote);
},
toc: {
level: [2]
Expand Down
9 changes: 9 additions & 0 deletions docs/.vitepress/glossary/data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ const data = {
both terms can be used interchangeably.
`,
},
command_palette: {
name: "Command Palette",
text: dedent `
A popup for quick access to various commands
provided by Sublime Text's core or a :package:.
Can be opened via ctrl/cmd+shift+p
or the Tools menu.
`,
},
view: {
text: dedent `
Graphical display of a buffer.
Expand Down
8 changes: 8 additions & 0 deletions docs/guide/customization/key_bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ title: Key Bindings
Key bindings let you
map sequences of key presses to commands.

The best practice to customize key bindings
is by editing the corresponding `Default (${platform}).sublime-keymap` file
in your <Term term="user_package" />
You can open this file,
along with default file for your platform,
using the **Preferences: Key Bindings** command
from the <Term term="command_palette" />.


## File Format

Expand Down
18 changes: 18 additions & 0 deletions docs/guide/example-setups/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Example Setups

This section contains a handful of "How to use Sublime with X" guides.

## Disclaimer

**These guides are opiniated** and may not match your workflow,
but they can help you get started
when working on a new language/technology.

## Programming Languages

- [How to use Sublime with Julia](./julia.md)
- [How to use Sublime with Typescript](./typescript.md)

## Workflows

- [How to use Sublime for remote development](./remote_dev.md)
Loading