jekyll doc theme herunterladen – jekyll doc theme Quellcode herunterladen

jekyll doc theme

Andere Kategorien

1.0.0

Herunterladen

Jekyll Doc-Theme

Detaillierte Informationen und eine Demo finden Sie auf der Website.

Läuft lokal

Sie benötigen Ruby und Gem, bevor Sie beginnen, dann:

 # 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

Themen-Assets

Im Zuge der Umstellung auf die Unterstützung von Github Pages wurden eine Reihe von Dateien in den Ordner /asset verschoben.

CSS/
Schriftarten/
img/
js/
404.html
allposts.html
search.json

Docker

Alternativ können Sie es mithilfe der mehrstufigen Docker-Datei bereitstellen, die Dateien von Nginx bereitstellt, um eine bessere Leistung in der Produktion zu erzielen.

Erstellen Sie das Bild für JEKYLL_BASEURL Ihrer Website:

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

(oder lassen Sie es für root leer: JEKYLL_BASEURL="" ) und servieren Sie es:

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

Github-Seiten

Das Theme ist auch für Github Pages verfügbar, indem das Remote Theme-Plugin verwendet wird:

Gemfile

 # 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

Themen-Assets

Dateien aus Ihrem Projekt überschreiben alle Designdateien mit demselben Namen. Der am häufigsten kommentierte Anwendungsfall hierfür wäre beispielsweise die Änderung des Themas oder der Farben Ihrer Website. Hierzu sollten folgende Schritte unternommen werden:

Kopieren Sie den Inhalt von aksakalli/jekyll-doc-theme/asset/css/main.scss in Ihr eigenes Projekt (unter Beibehaltung der Ordnerstruktur).
Ändern Sie die Variablen, die Sie verwenden möchten, vor den Importanweisungen, zum Beispiel:

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