diff --git a/docs/src/index.md b/docs/src/index.md index 1438199..afa8538 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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 @@ -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( diff --git a/examples/README.jl b/examples/README.jl index f801d74..5c24974 100644 --- a/examples/README.jl +++ b/examples/README.jl @@ -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") ``` =# @@ -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( diff --git a/templates/default/docs/src/index.md b/templates/default/docs/src/index.md index 88245eb..47b835f 100644 --- a/templates/default/docs/src/index.md +++ b/templates/default/docs/src/index.md @@ -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 @@ -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( diff --git a/templates/default/examples/README.jl b/templates/default/examples/README.jl index 8bbcf0d..d650ebc 100644 --- a/templates/default/examples/README.jl +++ b/templates/default/examples/README.jl @@ -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") ``` =# @@ -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(