Как вы создаете сайт Jekyll? - PullRequest
1 голос
/ 28 июля 2011

Скажите, пожалуйста, как создать базовый сайт Jekyll. Я особенно озадачен файлом _config.yml и темой YAML.

1 Ответ

15 голосов
/ 30 июля 2011

Я не совсем понимаю формулировку ваших вопросов, но я сделаю снимок. Я предполагаю, что вы имеете в виду одну из двух вещей. Либо файл конфигурации, либо фронтальный вопрос по YAML. В любом случае, ниже приведен базовый учебник по началу работы с сайтом Jekyll. Показывает использование обоих в контексте.

В пустой директории создайте следующее:

  1. Новый каталог с именем _layouts.

  2. Новый каталог с именем _posts.

  3. Новый каталог с именем _site.

  4. Файл с именем index.md со следующим содержимым:

    ---
    layout: default
    ---
    
    # My Jekyll site
    
    Welcome to my Jekyll site
    

    (Примечание. "Layout: default", окруженный двумя линиями черточек, - это передний вопрос YAML. Указание "default" означает, что jekyll будет использовать файл "default.html" в каталоге _layouts, указанном ниже.)

  5. Файл с именем _config.yml со следующим содержимым по умолчанию:

    safe:        false
    auto:        false
    server:      false
    server_port: 4000
    base-url:    /
    
    source:      .
    destination: ./_site
    plugins:     ./_plugins
    
    future:      true
    lsi:         false
    pygments:    false
    markdown:    maruku
    permalink:   date
    
    maruku:
      use_tex:    false
      use_divs:   false
      png_engine: blahtex
      png_dir:    images/latex
      png_url:    /images/latex
    
    rdiscount:
      extensions: []
    
    kramdown:
      auto_ids: true,
      footnote_nr: 1
      entity_output: as_char
      toc_levels: 1..6
      use_coderay: false
    
      coderay:
        coderay_wrap: div
        coderay_line_numbers: inline
        coderay_line_numbers_start: 1
        coderay_tab_width: 4
        coderay_bold_every: 10
        coderay_css: style
    

Для примера вы хотите создать еще два файла,

  1. Внутри каталога "_layouts" находится файл с именем default.html со следующим:

    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <html lang="en">
    <head>
        <meta charset="utf-8">
        <title>My Jekyll Site</title>
    </head>
    <body>
    
        <!-- This will be replaced with your content -->
        {{ content }}
    
    
    </body>
    </html>
    
  2. Внутри каталога "_posts" находится файл с именем 2011-07-29-my-first-jekyll-post.md со следующим:

    ---
    layout: default
    ---
    
    # My First Jekyll Post
    
    The quick brown fox jumps over the lazy dog. 
    

    (Примечание: еще раз, "layout: default", окруженный двумя линиями штрихов, является Front Matter YAML и указывает, что для шаблона будет использоваться "default.html".)


На этом этапе структура каталогов должна выглядеть следующим образом:

./_config.yml
./_layouts
./_posts
./_posts/2011-07-29-my-first-jekyll-post.md
./_site
./index.md

После того, как все, что установлено, из командной строки перейдите в каталог, в котором находится файл index.md, и запустите jekyll. Вы должны увидеть быстрый отчет вроде:

Configuration from /some-path/_config.yml
Building site: . -> ./_site
Successfully generated site: . -> ./_site

Будет создано два выходных файла:

  • . / _ Сайт / index.html
  • . / _ Сайта / 2011/07/29 / мой-первый-Джекил-post.html

Эти файлы соответствуют двум файлам разметки после того, как они были преобразованы в HTML и помещены в оболочку default.html, заменяющую строку "{{content}}".

Это должно начать с основ.

...