www.julialang.org

Readme

Dies ist das GitHub -Repository für die Hauptwebsite der Julia -Programmiersprache, Julialang.org. Das Repository für den Quellcode der Sprache selbst finden Sie unter github.com/julialang/julia.

Die Julia -Website wird mit Github -Seiten und Franklin.jl generiert, einem Julia Native Paket zum Erstellen statischer Websites.

Einfache Änderungen vornehmen

Um eine Änderung der Website vorzuschlagen, können Sie einfach mit dem Inhalt zur Seite navigieren, von dem Sie glauben, dass er geändert werden sollte, und sie bearbeiten. Sie werden aufgefordert, das Repo (wenn Sie es noch nicht getan haben) und dann eine Pull -Anfrage öffnen. Sobald Ihre Pull -Anfrage verschmolzen ist, sollten Sie Ihre Änderungen in wenigen Minuten oder weniger auf der Website angezeigt.

Die Erstellung der Vorschau für jede Pull -Anfrage wird im Kommentarbereich der PR verknüpft, sobald die Website erfolgreich erstellt wurde.

Hinweis : Bitte verwenden Sie nur eingezäunte Codeblöcke (dh Codeblöcke, die durch Back -Ticks abgelehnt wurden) und nicht eingerechter Codeblöcke.

Komplexere Änderungen vornehmen

Um eine Änderung der Website vorzuschlagen, die wichtiger ist, wird vorgeschlagen, dass Sie diese Änderungen vornehmen und lokal auf Ihrem Gerät testen. Sie können dies tun, indem Sie einfach das Basis -Repo aufgeben, lokal auf Ihr Gerät klonen, die gewünschten Änderungen vornehmen und dann den folgenden Anweisungen "lokal installieren" folgen.

Sobald Sie bestätigt haben, dass alles gut aussieht, können Sie eine Pull -Anfrage öffnen und die Bereitstellung der Vorschau von Netlify als endgültige Vernunftprüfung überprüfen.

Erstellen Sie Vorschau für jede Pull -Anforderung finden Sie unter: https://julialang.netlify.app (Beachten Sie, dass die Erstellungsvorschau angesichts des GitHub -Aktionsdesigns nur für diejenigen verfügbar sind, die einen Schreibzugriff auf das Repo haben).

Änderungen vornehmen und die Änderungen lokal sehen

Klonen Sie das Repository und cd darauf. Starten Sie Julia Version 1.10 mit julia --project und tun

julia > using Pkg; Pkg . instantiate ()

julia > using Franklin

julia > serve ()
→ Initial full pass ...
→ evaluating code [ ... ] (learning / code - examples . md)
→ Starting the server ...
✓ LiveServer listening on https : // localhost : 8000 / ...
  (use CTRL + C to shut down)

Navigieren Sie in einem Browser zu localhost:8000 und Sie sollten eine Vorschau auf Änderungen sehen, die Sie lokal vornehmen.

Ändern des CSS : Ändern Sie die relevanten Dateien in _css/ .

Ändern der HTML -Struktur : Wenn Sie die NAVBAR oder die Fußzeile ändern möchten, gehen Sie zu _layout/ und ändern Sie das relevante Vorlagenfragment.

Ändern der Zielseite : Da die Zielseite ein eigenes Design hat, ist sie in HTML mit einigen Einfügen von repurposenfähigen Fragmenten geschrieben, wobei Sie index.html einfach ändern können.

Hinzufügen eines Blog -Beitrags

Folgen Sie der Entwurf der vielen anderen Blog -Beiträge in Bezug auf Ordnerstruktur und Dateistruktur. Eine wichtige Sache, die Sie beachten sollten, ist, dass RSS in Bezug auf das, was es akzeptieren kann

• @def rss = ...
• @def title = ...

Insbesondere:

• Vermeiden Sie die Verwendung von & z. B. ändern ML&PL zu ML-PL ,
• Verwenden Sie nur einen einfachen Text in rss , keine Links, kein Markup, keine HTML -Entitäten.

Im Zweifelsfall, nach dem Ausführen von Franklins Server, kopieren Sie den Inhalt von __site/feed.xml in den W3 -Feed -Validator, er sollte "gültiger RSS -Feed" angezeigt.

Metadaten

Um <meta aaa="bbb" content="ccc"> tags in Ihrem Blog -Beitrag hinzuzufügen

 @def meta = [( " aaa " , " bbb " , " ccc " ),]

(Sie können natürlich mehrere Tags angeben). Siehe zum Beispiel Kenos jüngsten Blog -Beitrag.

Auf der Suche nach kaputten Links

Von Zeit zu Zeit sollte man eine ausführliche Überprüfung durchführen, dass es keine kaputten Links gibt. Während Franklin eine schnelle Möglichkeit bietet, ist es eine gute Idee, dies von Zeit zu Zeit ausführlich zu tun. Das Paket mit gebrochenem Link-Checker ist eine ziemlich ordentliche Möglichkeit, dies zu tun. Nach dem Installieren mit npm tun Sie es einfach

 blc https://julialang.org -ro

(Es dauert eine Weile und verlangt möglicherweise, dass Sie es in mehreren Schritten tun).

Fügen Sie Sprachen für die Syntax -Hervorhebung hinzu

Franklin verwendet Highlight.js für die Syntax -Hervorhebung. Um der von dieser Webseite verwendeten Bibliothek eine neue Sprache hinzuzufügen, fügen Sie die Bibliothek neu und fügen Sie der Liste eine neue Sprache hinzu. Aus der Wurzel des Highlight.js Repo:

 $ node tools/build.js bash c diff javascript json julia julia-repl plaintext python ruby shell ini yaml

Kopieren Sie die Bibliothek von build/highlight.min.js in _libs/highlight/highlight.min.js in diesem Repository.

Erstellen Sie Vorschau auf Netlify

Derzeit werden die Build -Vorschau über das Netlify -Konto von Logan Kilpatrick durchgeführt. Wenn das Konto offline ist und die Voransichten nicht mehr verfügbar sind, müssen Sie lediglich nur die Anmeldung für Netlify anmelden, ein Git-Repository (dieses Repo) importieren, die Filiale "GH-Preview" auswählen und dann die benutzerdefinierte Unterdomin "julialang.netlify.com" erstellen. Sie sollten dann in der Lage sein, die Voransichten entsprechend zu erstellen.

FAQ

enge Listen

Dies ist meistens ein Legacy -Gegenstand. Wenn die Listen auf der Seite falsch aussehen, öffnen Sie bitte ein Problem. Sie sollten nicht mehr @@tight-list ... @@ verwenden müssen.

Wenn Sie verschachtelte Listen wünschen, stellen Sie sicher, dass die Einklingel für die verschachtelte Liste mit Leerzeichen und nicht mit Registerkarten erstellt wird.