JuliaDocs/Franklin.jl

(docs) Franklin in CLI interactive mode

Open

#750 opened on Dec 31, 2020

View on GitHub
 (3 comments) (2 reactions) (0 assignees)Julia (1,060 stars) (118 forks)batch import
docsgood first issue

Description

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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of FranklinJulia installed
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue proposes adding a note about using `julia ie 'using Franklin; Franklin.serve()'` in the workflow documentation. Locate the workflow section in the Franklin.jl docs repository (likely under docs/). Add a short paragraph explaining that using the ` e` flag keeps Julia in interactive mode, allowing re running Franklin.serve() without reloading packages after an error.