Download jekyll doc theme - download do código-fonte jekyll doc theme

jekyll doc theme

Outras categorias

1.0.0

Baixar

Tema Jekyll Doc

Acesse o site para obter informações detalhadas e demonstração.

Executando localmente

Você precisa de Ruby e gem antes de começar, então:

 # install bundler
gem install bundler

# clone the project
git clone https://github.com/aksakalli/jekyll-doc-theme.git
cd jekyll-doc-theme

# install dependencies
bundle install

# run jekyll with dependencies
bundle exec jekyll serve

Ativos temáticos

A partir da mudança para oferecer suporte às páginas do Github, vários arquivos foram realocados para a pasta /asset .

css/
fontes/
imagem/
js/
404.html
todos os posts.html
pesquisa.json

Docker

Alternativamente, você pode implantá-lo usando o Dockerfile de vários estágios que fornece arquivos do Nginx para melhor desempenho na produção.

Crie a imagem para o JEKYLL_BASEURL do seu site:

 docker build --build-arg JEKYLL_BASEURL="/your-base/url" -t jekyll-doc-theme .

(ou deixe vazio para root: JEKYLL_BASEURL="" ) e sirva:

 docker run -p 8080:80 jekyll-doc-theme

Páginas do GitHub

O tema também está disponível para páginas do Github usando o plugin Remote Theme:

Arquivo Gem

 # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins

_config.yml

 # Configure the remote_theme plugin with the gh-pages branch
# or the specific tag
remote_theme: aksakalli/jekyll-doc-theme@gh-pages

Ativos temáticos

Os arquivos do seu projeto substituirão qualquer arquivo de tema com o mesmo nome. Por exemplo, o caso de uso mais comentado para isso seria modificar o tema ou as cores do seu site. Para fazer isso, as seguintes etapas devem ser executadas:

Copie o conteúdo de aksakalli/jekyll-doc-theme/asset/css/main.scss para seu próprio projeto (mantendo a estrutura de pastas)
Modifique as variáveis que deseja usar antes das instruções de importação, por exemplo:

 // Bootstrap variable overrides
$grid-gutter-width: 30px !default;
$container-desktop: (900px + $grid-gutter-width) !default;
$container-large-desktop: (900px + $grid-gutter-width) !default;

@import // Original import statement
  {% if site.bootwatch %}
    "bootswatch/{{site.bootwatch | downcase}}/variables",
  {% endif %}

  "bootstrap",

  {% if site.bootwatch %}
    "bootswatch/{{site.bootwatch | downcase}}/bootswatch",
  {% endif %}

  "syntax-highlighting",
  "typeahead",
  "jekyll-doc-theme"
;

// More custom overrides.