Unduh jekyll doc theme - Unduh kode sumber jekyll doc theme

jekyll doc theme

Kategori lainnya

1.0.0

Unduh

Tema Jekyll Doc

Kunjungi situs web untuk informasi detail dan demo.

Berjalan secara lokal

Anda memerlukan Ruby dan permata sebelum memulai, lalu:

 # 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

Aset Tema

Sejak perpindahan untuk mendukung Halaman Github, sejumlah file telah dipindahkan ke folder /asset .

css/
font/
gambar/
js/
404.html
semuaposts.html
pencarian.json

Buruh pelabuhan

Alternatifnya, Anda dapat menerapkannya menggunakan Dockerfile multi-tahap yang menyajikan file dari Nginx untuk kinerja produksi yang lebih baik.

Bangun gambar untuk JEKYLL_BASEURL situs Anda :

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

(atau biarkan kosong untuk root: JEKYLL_BASEURL="" ) dan sajikan:

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

Halaman Github

Tema ini juga tersedia di Halaman Github dengan memanfaatkan plugin Remote Theme:

File Permata

 # 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

Aset Tema

File dari proyek Anda akan menggantikan file tema apa pun dengan nama yang sama. Misalnya, kasus penggunaan komentar terbanyak untuk ini adalah mengubah tema atau warna situs Anda. Untuk melakukan hal ini, langkah-langkah berikut harus diambil:

Salin isi aksakalli/jekyll-doc-theme/asset/css/main.scss ke proyek Anda sendiri (pertahankan struktur folder)
Ubah variabel yang ingin Anda gunakan sebelum pernyataan import, misalnya:

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