www.julialang.org

Ридме

Это репозиторий GitHub для основного веб -сайта Julia программирования, Julialang.org. Репозиторий для исходного кода самого языка можно найти на github.com/julialang/julia.

Веб -сайт Julia генерируется с использованием страниц GitHub и Franklin.jl, местного пакета Джулии для создания статических веб -сайтов.

Внося простые изменения

Чтобы предложить изменение на веб -сайте, вы можете просто перейти на страницу с тем, что, по вашему мнению, следует изменить, и отредактировать его. Вам будет предложено разжечь репо (если вы еще этого не сделали), а затем откройте запрос на вытяжение. После того, как ваш запрос на привлечение объединится, вы должны увидеть, как ваши изменения появляются на веб -сайте через несколько минут или меньше.

Предварительные просмотра сборки для каждого запроса на привлечение будут связаны в разделе комментариев PR после успешного построения сайта.

Примечание . Пожалуйста, используйте только огороженные кодовые блоки (т.е. кодовые блоки, разграниченные обратными ногами), а не блоки кода с отступом.

Вносить более сложные изменения

Чтобы предложить изменение на веб -сайте, который является более значительным, предлагается внести указанные изменения и проверять их на своем устройстве. Вы можете сделать это, просто разбив базовый репо, клонируя его локально на свое устройство, внесло желаемые изменения, а затем следуя инструкциям «Установка локально» ниже.

После того, как вы подтвердили, что все выглядит хорошо, вы можете открыть запрос на вытяжение и проверить предварительный просмотр развертывания из NetLify в качестве окончательной проверки здравомыслия.

Предварительные просмотра сборки для каждого запроса на привлечение доступны по адресу: https://julialang.netlify.app (обратите внимание, что с учетом проектирования действий Github, предварительные просмотры доступны только для тех, кто имеет доступ к записи к репо).

Вносить модификации и увидеть изменения локально

Клонировать репозиторий и cd в него. Начните Julia версию 1.10 с julia --project и

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)

Перейдите к localhost:8000 в браузере, и вы должны увидеть предварительный просмотр любых модификаций, которые вы вносите локально.

Изменение CSS : изменить соответствующие файлы в _css/ .

Изменение структуры HTML : если вы хотите изменить Navbar или нижний колонтитул, перейдите к _layout/ и измените соответствующий фрагмент шаблона.

Изменение целевой страницы : Поскольку целевая страница имеет свой собственный дизайн, она написана в HTML с несколькими вставками перепрофилируемых фрагментов, где это необходимо, просто измените index.html

Добавление сообщения в блоге

Следите за проектом многих других сообщений в блоге с точки зрения структуры папок и структуры файлов. Одна важная вещь, которую нужно помнить, это то, что RSS немного разборчив с точки зрения того, что он может принять, так что будьте осторожны с тем, что происходит

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

В частности:

• Избегайте использования & , например, изменить ML&PL на ML-PL ,
• Используйте только простой текст в rss , без ссылок, без разметки, без HTML -сущностей.

Если вы сомневаетесь, после запуска сервера Франклина скопируйте содержимое __site/feed.xml в валидатор канала W3, он должен показать «допустимый RSS -канал».

Метаданные

Чтобы добавить <meta aaa="bbb" content="ccc"> теги в своем блоге, добавьте

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

(Конечно, вы можете указать несколько тегов). Смотрите, например, недавний пост Кено в блоге.

Ищу разбитые ссылки

Время от времени нужно провести глубокую проверку, что нет сломанных ссылок. В то время как Франклин обеспечивает быстрый способ сделать это, это хорошая идея, чтобы сделать это глубоко время от времени. Пакет-чередовой пакет-довольно аккуратный способ сделать это. После установки с npm просто сделайте

 blc https://julialang.org -ro

(Это занимает некоторое время, и может потребовать от вас сделать это через несколько шагов).

Добавить языки для выделения синтаксиса

Франклин использует hight.js для выделения синтаксиса. Чтобы добавить новый язык в библиотеку, используемую этой веб -страницей, перекомпиляйте библиотеку и добавьте новый язык в список. Из корня hight.js Repo:

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

Скопируйте библиотеку из build/highlight.min.js в _libs/highlight/highlight.min.js в этом репозитории.

Строите предварительные просмотры на NetLify

В настоящее время предварительные просмотра сборки проводятся через учетную запись Logan Kilpatrick's NetLify. Если учетная запись остается в автономном режиме, а предварительные просмотю больше не доступны, все, что вам нужно сделать, чтобы их восстановить, это зарегистрироваться для NetLify, импортировать репозиторий GIT (This Repo), выберите филиал «GH-Preview», а затем сделайте пользовательский субдомен «julialang.netlify.com». Затем вы должны быть в состоянии построить превью соответственно.

Часто задаваемые вопросы

плотные списки

Это в основном устаревший предмет. Если списки выглядят неправильно на странице, откройте проблему. Вам не нужно использовать @@tight-list ... @@ больше.

Если вам нужны вложенные списки, убедитесь, что отступ для вложенного списка состоит из мест , а не с вкладками.