jekyll doc theme下载 - jekyll doc theme源码下载

jekyll doc theme

其他类别

1.0.0

下载

Jekyll 文档主题

访问网站了解详细信息和演示。

本地运行

在开始之前你需要 Ruby 和 gem，然后：

 # 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 Pages 以来，许多文件已重新定位到/asset文件夹。

CSS/
字体/
图像/
js/
404.html
allposts.html
搜索.json

码头工人

或者，您可以使用多阶段 Dockerfile 来部署它，该文件从 Nginx 提供文件，以获得更好的生产性能。

为您网站的JEKYLL_BASEURL构建图像：

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

（或者将其留空以供 root 使用： JEKYLL_BASEURL="" ）并提供服务：

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

Github 页面

通过使用远程主题插件，Github Pages 也可以使用该主题：

宝石文件

 # 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的内容复制到您自己的项目（维护文件夹结构）
在 import 语句之前修改您希望使用的变量，例如：

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