# ods-jekyll-theme

**Repository Path**: mirrors_Orange-OpenSource/ods-jekyll-theme

## Basic Information

- **Project Name**: ods-jekyll-theme
- **Description**: Orange Design System theme for Jekyll documentation
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-22
- **Last Updated**: 2025-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">Orange Design System Jekyll Theme</h1>

<p align="center">
  Orange Design System Jekyll Theme provides a Jekyll theme for Orange powered by <a href="https://boosted.orange.com">Boosted</a> v5.3.3.
  <br>
  <a href="https://orange-opensource.github.io/ods-jekyll-theme/sample"><strong>Visit ODS Jekyll Theme sample page</strong></a>
</p>

## Table of contents

- [Rendering](#rendering)
- [Quick start](#quick-start)
- [Contributing](#contributing)
- [Copyright and license](#copyright-and-license)

## Rendering

Here is a sample page using this theme on [Github Pages](https://orange-opensource.github.io/ods-jekyll-theme/sample).

## Quick start

- Start by adding the theme in your `_config.yml`

``` yml
remote_theme: xxx/ods-boosted-theme
```

- In your markdown pages your can add some metadata into the header

```
---
layout: detail
title: Page title
description: Page description
---
```

## Contributing

Please read through our [contributing guidelines](https://github.com/Orange-OpenSource/ods-jekyll-theme/blob/main/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.

Please refer to the [developer guide](https://github.com/Orange-OpenSource/ods-jekyll-theme/blob/main/DEVELOP.md) for information on how to build the library.

## Copyright and license

Code released under the MIT License.