Franklin.jl
Franklin.jl copied to clipboard
(docs) Franklin in CLI interactive mode
Kindly suggested by @rikhuijzer
I like to use
julia -ie 'using Franklin; Franklin.serve()
. Thanks to usinge
, Julia will remain open in interactive mode even when Franklin stops. When Franklin has errored out, you can callFranklin.serve()
again without having to reload Julia and all the packages.
This could be added in the "workflow" docs.
On second thought, it might be better to advise
julia --project -ie 'using Franklin; Franklin.serve()'
because then users are encouraged to use a Manifest.toml
and avoid problems introduced by having different versions when running locally or via CI.
can you give me right direction, how to solve this issue I'm new to open source
Thanks @javedbaig, you could add a paragraph here: http://franklinjl.org/workflow/#editing_and_testing_your_website to do so you'd have to edit the file docs/workflow/index.md
(this one: https://github.com/tlienart/Franklin.jl/blob/master/docs/workflow/index.md) and insert a paragraph there, potentially a subsection. (Maybe test the interactive mode first to check how this works which can help in explaining it to other users).
The steps to getting your changes in are essentially
- edit the file (you can do this from GitHub even)
- open a pull request (GitHub should help you with this)
- wait for people to review and comment
- adjust according to feedback
- I eventually merge your changes
see also something like this: https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/