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 (118 forks)batch import
docsgood first issue

Repository metrics

Stars
 (1,060 stars)
PR merge metrics
 (Avg merge 71d 9h) (4 merged PRs in 30d)

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

Research direction
Add a note in the workflow documentation about using `julia ie 'using Franklin; Franklin.serve()'` to keep Julia in interactive mode even when Franklin stops, allowing to restart serve without reloading packages.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90