search

tlienart / Franklin.jl

(yet another) static site generator. Simple, customisable, fast, maths with KaTeX, code evaluation, optional pre-rendering, in Julia.
https://franklinjl.org
MIT License
951 stars 113 forks source link

(docs) Franklin in CLI interactive mode #750

Open tlienart opened 3 years ago

tlienart commented 3 years ago

Kindly suggested by @rikhuijzer

I like to use julia -ie 'using Franklin; Franklin.serve(). Thanks to using e, Julia will remain open in interactive mode even when Franklin stops. When Franklin has errored out, you can call Franklin.serve() again without having to reload Julia and all the packages.

This could be added in the "workflow" docs.

rikhuijzer commented 3 years ago

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.

javedbaig commented 3 years ago

can you give me right direction, how to solve this issue I'm new to open source

tlienart commented 3 years ago

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

  1. edit the file (you can do this from GitHub even)
  2. open a pull request (GitHub should help you with this)
  3. wait for people to review and comment
  4. adjust according to feedback
  5. 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/