Go to the website for detailed information and demo.
You need Ruby and gem before starting, then:
# 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 serveAs of the move to support Github Pages a number of files have been relocated to the /asset folder.
- css/
- fonts/
- img/
- js/
- 404.html
- allposts.html
- search.json
Alternatively, you can deploy it using the multi-stage Dockerfile that serves files from Nginx for better performance in production.
Build the image for your site's JEKYLL_BASEURL:
docker build --build-arg JEKYLL_BASEURL="/your-base/url" -t jekyll-doc-theme .
(or leave it empty for root: JEKYLL_BASEURL="") and serve it:
docker run -p 8080:80 jekyll-doc-theme
The theme is also available to Github Pages by making use of the Remote Theme plugin:
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
Files from your project will override any theme file with the same name. For example, the most comment use case for this, would be to modify your sites theme or colors. To do this, the following steps should be taken:
- Copy the contents of the
aksakalli/jekyll-doc-theme/asset/css/main.scssto your own project (maintaining folder structure) - Modify the variables you wish to use prior to the import statements, for example:
// 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.
- Import or override any other theme styles after the standard imports
- http://teavm.org/
- https://ogb.stanford.edu/
- https://griddb.org/
- https://su2code.github.io/
- https://launchany.github.io/mvd-template/
- https://knowit.github.io/kubernetes-workshop/
- https://rec.danmuji.org/
- https://nethesis.github.io/icaro/
- http://ai.cs.ucl.ac.uk/
- http://tizonia.org
- https://lakka-switch.github.io/documentation/
- https://cs.anu.edu.au/cybersec/issisp2018/
- http://www.channotation.org/
- http://nemo.apache.org/
- https://csuf-acm.github.io/
- https://extemporelang.github.io/
- https://media-ed-online.github.io/intro-web-dev-2018spr/
- https://midlevel.github.io/MLAPI/
- https://pulp-platform.github.io/ariane/docs/home/
- https://koopjs.github.io/
- https://developer.apiture.com/
- https://contextmapper.github.io/
- https://www.bruttin.com/CosmosDbExplorer/
- http://mosaic-lopow.github.io/dash7-ap-open-source-stack/
- http://www.vstream.ml/
- http://docs.fronthack.com/
- https://repaircafeportsmouth.org.uk/
- http://brotherskeeperkenya.com/
- https://hschne.at/Fluentast/
- https://zoe-analytics.eu/
- https://uli.kmz-brno.cz/
- https://lime.software/
- https://weft.aka.farm
- https://microros.github.io/
- https://citystoriesucla.github.io/citystories-LA-docs
- http://lessrt.org/
- http://kivik.io/
- https://www.iot-kit.nl/
- http://justindietz.com/
- https://universalsplitscreen.github.io/
- https://docs.oneflowcloud.com/
- https://actlist.silentsoft.org/
- https://teevid.github.io
- https://developer.ipums.org
- https://osmpersia.github.io (right-to-left)
- https://ecmlpkdd2019.org
- https://idle.land
- https://mqless.com
- https://muict-seru.github.io/
- https://www.invoice-x.org
- https://www.devops.geek.nz
Released under the MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent