https://github.com/connor-baer/winter

❄️ Winter is a Jekyll theme built for documentation.
https://github.com/connor-baer/winter

documentation jekyll jekyll-theme theme

Last synced: about 1 month ago
JSON representation

❄️ Winter is a Jekyll theme built for documentation.

• Host: GitHub
• URL: https://github.com/connor-baer/winter
• Owner: connor-baer
• License: other
• Created: 2016-12-13T14:49:54.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-03-19T07:35:31.000Z (8 months ago)
• Last Synced: 2024-10-05T18:27:07.833Z (about 2 months ago)
• Topics: documentation, jekyll, jekyll-theme, theme
• Language: SCSS
• Homepage: https://connor-baer.github.io/winter/
• Size: 4 MB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/connor-baer/winter.svg?branch=master)](https://travis-ci.org/connor-baer/winter) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/629109c53398418981bbc5929f330562)](https://www.codacy.com/app/connor_baer/winter?utm_source=github.com&utm_medium=referral&utm_content=connor-baer/winter&utm_campaign=Badge_Grade)

# 🌱 Winter

A [Jekyll](http://jekyllrb.com) theme built for documentation, loosely based on [Hyde](http://hyde.getpoole.com/), by [@mdo](https://twitter.com/mdo)

> ⚠️ This theme should work as-is, but is no longer actively maintained. [Contributions](#contributing) are welcome!

[![Winter screenshot](https://github.com/connor-baer/winter/blob/master/_images/screenshot.jpg)](https://connor-baer.github.io/winter)

## Usage

You'll need to have [Jekyll](https://jekyllrb.com/), the `bundler` gem, and [`yarn`](https://yarnpkg.com/) (`npm` also works) installed on our computer. Winter provides a fully furnished Jekyll setup — just clone and install the dependencies:

```bash

# Ruby gems

bundle install

# Node modules

yarn

```

Then simply run `yarn start` to start the Jekyll server on port `4000`.

## Options

Winter shines with a simple & intuitive interface, multi-language support, and full content search. It includes some customizable options, applied via options in the `_config.yml` file. Have a look at the [`_config.yml`](_config.yml) file for all available options.

## Contributing

**This theme is no longer actively maintained.** However, I welcome bug fixes and feature request through [pull requests](https://github.com/connor-baer/winter/compare). If you don't feel comfortable making code changes, feel free to [open an issue](https://github.com/connor-baer/winter/issues/new), perhaps somebody else will help out.

## License

Open sourced under the [MIT license](LICENSE.md).

💙