Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aksakalli/jekyll-doc-theme
Jekyll theme for creating project documentation websites
https://github.com/aksakalli/jekyll-doc-theme
bootstrap jekyll jekyll-theme sass static-site static-site-generator theme
Last synced: 1 day ago
JSON representation
Jekyll theme for creating project documentation websites
- Host: GitHub
- URL: https://github.com/aksakalli/jekyll-doc-theme
- Owner: aksakalli
- License: mit
- Created: 2017-05-03T17:48:59.000Z (over 7 years ago)
- Default Branch: gh-pages
- Last Pushed: 2024-02-29T02:06:16.000Z (11 months ago)
- Last Synced: 2025-01-18T04:06:16.277Z (8 days ago)
- Topics: bootstrap, jekyll, jekyll-theme, sass, static-site, static-site-generator, theme
- Language: SCSS
- Homepage: https://aksakalli.github.io/jekyll-doc-theme/
- Size: 3.01 MB
- Stars: 292
- Watchers: 17
- Forks: 262
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - aksakalli/jekyll-doc-theme - Jekyll theme for creating project documentation websites (sass)
README
# Jekyll Doc Theme
Go to [the website](https://aksakalli.github.io/jekyll-doc-theme/) for detailed information and demo.
## Running locally
You need Ruby and gem before starting, then:
```bash
# 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
```
### Theme Assets
As of the move to support [Github Pages](https://pages.github.com/) a number of files have been relocated to the `/asset` folder.
- css/
- fonts/
- img/
- js/
- 404.html
- allposts.html
- search.json
## Docker
Alternatively, you can deploy it using the multi-stage [Dockerfile](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
```
## Github Pages
The theme is also available to [Github Pages](https://pages.github.com/) by making use of the [Remote Theme](https://github.com/benbalter/jekyll-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
```
### Theme Assets
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:
1) Copy the contents of the `aksakalli/jekyll-doc-theme/asset/css/main.scss` to your own project (maintaining folder structure)
2) 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.
```
3) Import or override any other theme styles after the standard imports
## Projects using Jekyll Doc Theme
* http://teavm.org/
* https://ogb.stanford.edu/
* https://griddb.org/
* https://su2code.github.io/
* https://contextmapper.org/
* 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
## License
Released under [the MIT license](LICENSE).