Skip to content
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.

Sign up for GitHub

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

Code block highlighting/formatting #10

Closed
wants to merge 1 commit into from
Closed

Code block highlighting/formatting #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ EditURL = "../../examples/README.jl"

## Installation instructions

```julia
julia> using Pkg: Pkg

julia> Pkg.add("https://github.com/ITensor/ITensorPkgSkeleton.jl")
```@repl
using Pkg: Pkg
Pkg.add("https://github.com/ITensor/ITensorPkgSkeleton.jl")
```

## Examples
Expand All @@ -38,8 +37,10 @@ If `path` isn't specified, it defaults to `~/.julia/dev`.
ITensorPkgSkeleton.generate("NewPkg"; path=tempdir())
````

You can generate this README with:
```julia
## Generating this page

You can generate this page with:
```@example
using Literate: Literate
using ITensorPkgSkeleton: ITensorPkgSkeleton
Literate.markdown(
Expand Down
13 changes: 7 additions & 6 deletions examples/README.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@
# ## Installation instructions

#=
```julia
julia> using Pkg: Pkg

julia> Pkg.add("https://github.com/ITensor/ITensorPkgSkeleton.jl")
```@repl
using Pkg: Pkg
Pkg.add("https://github.com/ITensor/ITensorPkgSkeleton.jl")
```
=#

Expand All @@ -26,9 +25,11 @@ ITensorPkgSkeleton.use_system_git!()
# If `path` isn't specified, it defaults to `~/.julia/dev`.
ITensorPkgSkeleton.generate("NewPkg"; path=tempdir())

# You can generate this README with:
# ## Generating this page

# You can generate this page with:
#=
```julia
```@example
using Literate: Literate
using ITensorPkgSkeleton: ITensorPkgSkeleton
Literate.markdown(
Expand Down
9 changes: 4 additions & 5 deletions templates/default/docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ EditURL = "../../examples/README.jl"

## Installation instructions

```julia
julia> using Pkg: Pkg

julia> Pkg.add("https://github.com/ITensor/{PKGNAME}.jl")
```@repl
using Pkg: Pkg
Pkg.add("https://github.com/ITensor/{PKGNAME}.jl")
```

## Examples
Expand All @@ -28,7 +27,7 @@ using {PKGNAME}: {PKGNAME}
Show examples of using {PKGNAME}.jl

You can generate this README with:
```julia
```@example
using Literate: Literate
using {PKGNAME}: {PKGNAME}
Literate.markdown(
Expand Down
11 changes: 6 additions & 5 deletions templates/default/examples/README.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@
# ## Installation instructions

#=
```julia
julia> using Pkg: Pkg

julia> Pkg.add("https://github.com/ITensor/{PKGNAME}.jl")
```@repl
using Pkg: Pkg
Pkg.add("https://github.com/ITensor/{PKGNAME}.jl")
```
=#

Expand All @@ -22,9 +21,11 @@ julia> Pkg.add("https://github.com/ITensor/{PKGNAME}.jl")
using {PKGNAME}: {PKGNAME}
# Show examples of using {PKGNAME}.jl

# ## Generating this page

# You can generate this README with:
#=
```julia
```@example
using Literate: Literate
using {PKGNAME}: {PKGNAME}
Literate.markdown(
Expand Down
Loading