alexwlchan.net

alexwlchan.net

У этого репо есть код для моего личного сайта Alexwlchan.net, который представляет собой статический сайт, построенный с Jekyll. Он включает в себя ряд плагинов, которые я написал для настройки сайта.

Ключевые инструменты

Сайт использует:

• Jekyll, который генерирует HTML -страницы
• Sass, для создания CSS и таблиц стилей
• Действия GitHub, которые создают и развертывают сайт
• Caddy, который является веб -сервером

Когда я хочу внести изменения, я открываю запрос на тягу. Это запускает сборку с действиями GitHub, и как часть сборки он проверяет HTML с помощью HTMLOPRECTER. Это проверяет отсутствие текста Alt, разбитые ссылки, недействительный HTML и так далее.

Если сайт проходит чеки, он автоматически объединяется, и настройка на main филиале публикует изменение на моем веб -сервере.

Построение сайта

Вам нужны установлены git, ruby ​​и python.

Чтобы запустить локальную копию сайта:

$ git clone [email protected]:alexwlchan/alexwlchan.net.git

$ python3 -m venv .venv
$ pip install -r requirements.txt

$ bundle install

$ bundle exec jekyll serve

Сайт должен работать на http: // localhost: 5757. Если вы внесете изменения в исходные файлы, он автоматически обновит.

Чтобы создать одноразовый набор статических HTML-файлов:

$ bundle exec jekyll build

Это создает набор HTML -файлов в _site .

Как работает сайт

Я публикую исходный код, чтобы другие люди могли видеть, как работает сайт, и, возможно, использует некоторые идеи для своих собственных сайтов. Это список вещей, которые я считаю интересными или необычными:

• Поколение подачи атома
• No-Javascript Twitter Enceds
• Ссылка на мою работу на других сайтах
• Проверка переднего вопроса в файлах маркировки

Внося

Установки для опечаток приветствуются, но в остальном вклады будут игнорироваться.

Если вы хотите использовать какие -либо компоненты в своих собственных проектах - плагины, макеты, таблицы стилей - не стесняйтесь сделать это.

Лицензия

• За исключением случаев, когда иное отмечено, сайт и связанный код двойной лицензии как:

  • Creative Commons Attribution 4.0 International (aka cc by 4.0)
  • Лицензия MIT

  Если вы повторно используете мой контент, вы можете использовать любую лицензию, которая наиболее подходит.

  В основном CC - это нормально, но лицензии Creative Commons не подходят для кода, поэтому у меня есть MIT в качестве альтернативы.

• Некоторые изображения, которые используются в рамках лицензий Creative Commons от других людей; Смотрите пост, где изображение используется для атрибуции.

• Все иконки на сайте используются под лицензией без роялти от существительного проекта; В файлах SVG должны быть комментарии, указывающие их источник. Оригинальные авторы иконы сохраняют авторские права.