JuliaDocs/Franklin.jl

(docs) Franklin in CLI interactive mode

Open

#750 geöffnet am 31. Dez. 2020

Auf GitHub ansehen
 (3 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Julia (1.060 Stars) (118 Forks)batch import
docsgood first issue

Beschreibung

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
Keine
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic knowledge of FranklinJulia installed
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.