Skip to content

Commit

Permalink
Merge pull request #26 from ostranme/3.0.0-wip
Browse files Browse the repository at this point in the history
3.0.0 Initial Release
  • Loading branch information
ostranme authored Mar 31, 2017
2 parents fd9793c + 052200a commit 9a487e2
Show file tree
Hide file tree
Showing 31 changed files with 11,878 additions and 14 deletions.
69 changes: 57 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Swagger UI Themes

*Version 2.1.0*
*Version 3.0.0*

[![npm](https://img.shields.io/npm/v/swagger-ui-themes.svg?style=flat-square)](https://www.npmjs.com/package/swagger-ui-themes)
[![Bower](https://img.shields.io/bower/v/swagger-ui-themes.svg?style=flat-square)](https://github.com/ostranme/swagger-ui-themes)
Expand All @@ -15,15 +15,37 @@

## Getting started

Download the swagger-ui-themes project and place the desired stylesheet into the source of your swagger-ui html.
Download the swagger-ui-themes project and place the desired stylesheet into the source of your swagger-ui html. Use the `3.x` or `2.x` directories depending on what version of Swagger UI you have.

In the `<head>` of your html, reference the location to your [theme].css
```
├── 2.x
│   ├── theme-feeling-blue.css
│   ├── theme-flattop.css
│   ├── theme-material.css
│   ├── theme-monokai.css
│   ├── theme-muted.css
│   ├── theme-newspaper.css
│   └── theme-outline.css
└── 3.x
├── theme-feeling-blue.css
├── theme-flattop.css
├── theme-material.css
├── theme-monokai.css
├── theme-muted.css
├── theme-newspaper.css
└── theme-outline.css
```

Make sure to either remove/comment out the link to `screen.css` or load the desired theme after to override the default Swagger UI styles.
In the `<head>` of your html, reference the location to your [theme].css

```html
<link rel="stylesheet" href="path/to/swagger-ui-themes/css/theme-flattop.css">
```

- For `3.x`, make sure to either remove/comment out the link to `swagger-ui.css` or load the desired theme after to override the default Swagger UI styles.

- For `2.x`, make sure to either remove/comment out the link to `screen.css` or load the desired theme after to override the default Swagger UI styles.

#### Install with bower

```shell
Expand All @@ -36,28 +58,51 @@ $ bower install swagger-ui-themes
$ npm install swagger-ui-themes
```

## Themes
## 3.x Themes

#### Material
![Material Screenshot](screenshots/3.x/3.x-material.png)

#### Flattop
![Flattop Screenshot](screenshots/3.x/3.x-flattop.png)

#### Muted
![Muted Screenshot](screenshots/3.x/3.x-muted.png)

#### Newspaper
![Newspaper Screenshot](screenshots/3.x/3.x-newspaper.png)

#### Outline
![Outline Screenshot](screenshots/3.x/3.x-outline.png)

#### Monokai
![Monokai Screenshot](screenshots/3.x/3.x-monokai.png)

#### Feeling Blue
![Feeling Blue Screenshot](screenshots/3.x/3.x-feeling-blue.png)

## 2.x Themes

#### Material
![Material Screenshot](screenshots/material.png)
![Material Screenshot](screenshots/2.x/2.x-material.png)

#### Flattop
![Flattop Screenshot](screenshots/flattop.png)
![Flattop Screenshot](screenshots/2.x/2.x-flattop.png)

#### Muted
![Muted Screenshot](screenshots/muted.png)
![Muted Screenshot](screenshots/2.x/2.x-muted.png)

#### Newspaper
![Newspaper Screenshot](screenshots/newspaper.png)
![Newspaper Screenshot](screenshots/2.x/2.x-newspaper.png)

#### Outline
![Outline Screenshot](screenshots/outline.png)
![Outline Screenshot](screenshots/2.x/2.x-outline.png)

#### Monokai
![Monokai Screenshot](screenshots/monokai.png)
![Monokai Screenshot](screenshots/2.x/2.x-monokai.png)

#### Feeling Blue
![Feeling Blue Screenshot](screenshots/feeling-blue.png)
![Feeling Blue Screenshot](screenshots/2.x/2.x-feeling-blue.png)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "swagger-ui-themes",
"version": "2.1.0",
"version": "3.0.0",
"homepage": "https://github.com/ostranme/swagger-ui-themes",
"author":
"Mark Ostrander <[email protected]>",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "swagger-ui-themes",
"description": "A collection of CSS themes for Swagger UI",
"version": "2.1.0",
"version": "3.0.0",
"keywords": ["theme", "swagger", "swagger UI", "ui", "flat"],
"homepage": "http://meostrander.com/swagger-ui-themes",
"bugs": {
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added screenshots/3.x/3.x-feeling-blue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/3.x/3.x-flattop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/3.x/3.x-material.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/3.x/3.x-monokai.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/3.x/3.x-muted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/3.x/3.x-newspaper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/3.x/3.x-outline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 9a487e2

Please sign in to comment.