jekyll doc theme Télécharger - jekyll doc theme Téléchargement du code source

jekyll doc theme

Autres catégories

1.0.0

Télécharger

Thème Jekyll Doc

Accédez au site Web pour des informations détaillées et une démonstration.

Exécution locale

Vous avez besoin de Ruby et de gem avant de commencer, alors :

 # 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

Actifs du thème

Depuis la transition vers la prise en charge des pages Github, un certain nombre de fichiers ont été déplacés vers le dossier /asset .

css/
polices/
img/
js/
404.html
tous les messages.html
recherche.json

Docker

Vous pouvez également le déployer à l'aide du Dockerfile en plusieurs étapes qui sert les fichiers de Nginx pour de meilleures performances en production.

Créez l'image pour JEKYLL_BASEURL de votre site :

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

(ou laissez-le vide pour root : JEKYLL_BASEURL="" ) et servez-le :

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

Pages GitHub

Le thème est également disponible sur les pages Github en utilisant le plugin Remote Theme :

Fichier de pierres précieuses

 # 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

Actifs du thème

Les fichiers de votre projet remplaceront tout fichier de thème portant le même nom. Par exemple, le cas d’utilisation le plus commenté serait de modifier le thème ou les couleurs de votre site. Pour ce faire, les étapes suivantes doivent être suivies :

Copiez le contenu de aksakalli/jekyll-doc-theme/asset/css/main.scss dans votre propre projet (en conservant la structure des dossiers)
Modifiez les variables que vous souhaitez utiliser avant les instructions d'importation, par exemple :

 // 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.