Skip to content

Commit fac504c

Browse files
authored
Merge pull request #81 from hyrodium/fix/docs
Update URL and code blocks
2 parents c03c4be + 648811c commit fac504c

File tree

8 files changed

+13
-13
lines changed

8 files changed

+13
-13
lines changed

docs/make.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ using Documenter
33
include("preprocess.jl")
44

55
# download latest changelog
6-
download("https://raw.githubusercontent.com/julia-vscode/julia-vscode/master/CHANGELOG.md", joinpath(@__DIR__, "src", "changelog.md"))
6+
download("https://raw.githubusercontent.com/julia-vscode/julia-vscode/main/CHANGELOG.md", joinpath(@__DIR__, "src", "changelog.md"))
77
# download package.json so we can generate an overview over keybindings/commands/...
8-
download("https://raw.githubusercontent.com/julia-vscode/julia-vscode/master/package.json", joinpath(@__DIR__, "src", "package.json"))
8+
download("https://raw.githubusercontent.com/julia-vscode/julia-vscode/main/package.json", joinpath(@__DIR__, "src", "package.json"))
99

1010
generate_keybindings()
1111

docs/preprocess.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ function generate_keybindings()
2121
println(io, "# Keybindings & Commands")
2222

2323
println(io, """
24-
This page was auto-generated from [julia-vscode's package.json](https://github.com/julia-vscode/julia-vscode/blob/master/package.json)
24+
This page was auto-generated from [julia-vscode's package.json](https://github.com/julia-vscode/julia-vscode/blob/main/package.json)
2525
version $(package["version"]).
2626
""")
2727

docs/src/gettingstarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The .jl file extension indicates to VS Code that you interpret this file as a Ju
5555

5656
3. Enter the following source code in hello.jl:
5757

58-
```
58+
```julia
5959
msg = "Hello World"
6060
println(msg)
6161
```

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Julia Visual Studio Code Documentation
22

3-
**NOTE**: _This documentation is currently being updated and revamped. In the meantime, the [CHANGELOG](https://github.com/julia-vscode/julia-vscode/blob/master/CHANGELOG.md) and pull requests linked within may serve as a useful reference of as yet undocumented features._
3+
**NOTE**: _This documentation is currently being updated and revamped. In the meantime, the [CHANGELOG](https://github.com/julia-vscode/julia-vscode/blob/main/CHANGELOG.md) and pull requests linked within may serve as a useful reference of as yet undocumented features._
44

55
Julia for Visual Studio Code is a powerful, free IDE for the Julia language. Visual Studio Code is a powerful and customizable editor. With a completely live environment, Julia for VS Code aims to take the frustration and guesswork out of programming and put the fun back in. We build on Julia’s unique combination of ease-of-use and performance. Beginners and experts can build better software more quickly, and get to a result faster. Julia is an officially supported language on the [VS Code docs](https://code.visualstudio.com/docs/languages/julia).
66

docs/src/userguide/compilesysimage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Additional options can be passed to further tweak the compilation. In particular
1414

1515
This file should be named `./.vscode/JuliaSysimage.toml` and be placed under the project root file. Its content should look like:
1616

17-
```
17+
```toml
1818
[sysimage]
1919
exclude=["Pkg1", "Pkg2"] # Additional packages to be excluded in the system image
2020
statements_files=["relative/path/to/precompile_statements_file.jl", ]

docs/src/userguide/debugging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Click on the Debugger Default Compiled extension setting.
120120
![Debugger](../assets/debugger/16.png)
121121

122122
Configure this setting as follows.
123-
```
123+
```json
124124
"julia.debuggerDefaultCompiled": [
125125
"ALL_MODULES_EXCEPT_MAIN",
126126
"-Statistics.",
@@ -135,7 +135,7 @@ Custom julia sys images can also be used when debugging. Go to julia-vscode exte
135135

136136

137137
Once in the settings, use "-J" option followed by your path to the custom sys image. Note this "Additional Args" settings are currently used only when debugging in the REPL mode, see the `@run` macron in the example bellow.
138-
```
138+
```json
139139
"julia.additionalArgs": [
140140
"-JC:\\temp\\sys_custom.so",
141141
],

docs/src/userguide/plotgallery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ Julia `Plots` provides us with the capability to create visualizations of data.
66
First, `Open` the Julia Terminal (also known as REPL), you can follow the steps [here](https://www.julia-vscode.org/docs/stable/userguide/runningcode/#The-Julia-REPL-1).
77

88
At the Julia prompt in the REPL window, type the following:
9-
```
9+
```julia-repl
1010
julia> using Pkg
1111
```
1212
This will tell Julia that you are going to use the package manager.
1313

1414
Then type the following to add `Plots` package:
15-
```
15+
```julia-repl
1616
julia> Pkg.add("Plots")
1717
```
1818
## Create Visualization
1919
**Remember** to keep the REPL open as this is where any output from your program will be printed.
2020

2121
The first piece of code that you need to execute is this:
22-
```
22+
```julia
2323
using Plots
2424
```
2525
This tells Julia to load the library that we will use to create our visualizations.
@@ -29,7 +29,7 @@ This tells Julia to load the library that we will use to create our visualizatio
2929
Let's walkthrough a simple program to understand this:
3030

3131
Write the following code.
32-
```
32+
```julia
3333
using Plots
3434
x = 1:10; y = rand(10); # These are the plotting data
3535
plot(x,y, label="my label")

docs/src/userguide/profiler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Julia comes with it's own [sampling profiler](https://docs.julialang.org/en/v1/stdlib/Profile/) and there are [various packages](https://github.com/timholy/FlameGraphs.jl) to visualize these profile traces.
44

55
The VS Code extension comes with it's own profile viewer. Profiling the example function from the [ProfileView.jl readme](https://github.com/timholy/ProfileView.jl)
6-
```
6+
```julia
77
function profile_test(n)
88
for i = 1:n
99
A = randn(100,100,20)

0 commit comments

Comments
 (0)