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.

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

Working with Literate? #166

Closed
gdalle opened this issue Jun 30, 2023 · 3 comments
Closed

Working with Literate? #166

gdalle opened this issue Jun 30, 2023 · 3 comments
Labels

Comments

@gdalle
Copy link

gdalle commented Jun 30, 2023

Thanks for the awesome package!

How is one supposed to work with Literate? The link to the docs in the README is broken

@tlienart
Copy link
Collaborator

Hello @gdalle, yeah I need to fix the docs + link..

try this please:

julia> using LiveServer, Documenter, Literate
julia> LiveServer.servedocs_literate_example()
julia> cd("servedocs_literate_example")
julia> servedocs(literate=joinpath("docs", "literate"))

this will create a folder servedocs_literate_example with a simple folder structure; if you modify scripts in docs/literate the changes will be reflected in your browser.

For now there's the assumption that Literate generates a md file next to the .jl script, if this bothers you, keep an eye on the ongoing discussion in #165 .

@tlienart tlienart added the docs label Jun 30, 2023
@gdalle
Copy link
Author

gdalle commented Jun 30, 2023

Thanks!!

@tlienart
Copy link
Collaborator

(doc link fixed)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants