jekyll doc theme
1.0.0
انتقل إلى الموقع للحصول على معلومات مفصلة والعرض التوضيحي.
أنت بحاجة إلى روبي والجوهرة قبل البدء، ثم:
# 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
اعتبارًا من التحرك لدعم صفحات Github، تم نقل عدد من الملفات إلى المجلد /asset
.
وبدلاً من ذلك، يمكنك نشره باستخدام ملف Dockerfile متعدد المراحل الذي يخدم الملفات من Nginx للحصول على أداء أفضل في الإنتاج.
أنشئ الصورة لـ JEKYLL_BASEURL
لموقعك:
docker build --build-arg JEKYLL_BASEURL="/your-base/url" -t jekyll-doc-theme .
(أو اتركه فارغًا للجذر: JEKYLL_BASEURL=""
) وقدمه:
docker run -p 8080:80 jekyll-doc-theme
السمة متاحة أيضًا لصفحات Github من خلال الاستفادة من المكوّن الإضافي Remote Theme:
ملف جيمفيل
# 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
ستحل الملفات من مشروعك محل أي ملف سمة يحمل نفس الاسم. على سبيل المثال، أكثر حالات استخدام التعليقات لهذا الغرض هي تعديل سمة موقع الويب الخاص بك أو ألوانه. للقيام بذلك، ينبغي اتخاذ الخطوات التالية:
aksakalli/jekyll-doc-theme/asset/css/main.scss
إلى مشروعك الخاص (مع الحفاظ على بنية المجلد) // 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.
تم إصداره بموجب ترخيص MIT.