jekyll doc theme
1.0.0
請造訪網站以了解詳細資訊和演示。
在開始之前你需要 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
資料夾。
或者,您可以使用多階段 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 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
的內容複製到您自己的專案(維護資料夾結構) // 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.
根據麻省理工學院許可發布。