https://github.com/laurencee9/jekyll-flat-api

A Jekyll theme for API documentation
https://github.com/laurencee9/jekyll-flat-api

api-documentation jekyll jekyll-theme

Last synced: about 1 month ago
JSON representation

A Jekyll theme for API documentation

• Host: GitHub
• URL: https://github.com/laurencee9/jekyll-flat-api
• Owner: laurencee9
• License: mit
• Created: 2018-04-03T18:53:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-30T22:09:47.000Z (over 3 years ago)
• Last Synced: 2024-05-03T19:18:12.212Z (7 months ago)
• Topics: api-documentation, jekyll, jekyll-theme
• Language: HTML
• Homepage: https://jekyll-theme-api-documentation.github.io
• Size: 989 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jekyll flat API

A Jekyll theme for API documentation. It is inspired by the beautifully designed API of unsplash. 

[**Click here for demo**](https://jekyll-theme-api-documentation.github.io)

![](./assets/images/example1.png) 

## Usage

Simply run

```

jekyll server

```

If something goes wrong, follow the instruction from [jekyll](https://jekyllrb.com/docs/themes/).

## Creating content

The content of the API is located in `_documentation`. You can create as many folders as you want to organize your API. In each subfolder of `_documentation`, you may find markdown files. 

### Jekyll tags

Files with `front: true` in their header will be presented as sections leaders in the navigation bar. Those leaders can be ordered using the `order: ` tag in the markdown file. For example, `_documentation/photos/photos.md` is the leader of the photo section. 

It is very important that the files with `front: false` have a permalink such that it contains the permalink of its section leader. 

### Image

The top image and the main title can be modified in `_includes/home.html`. 

### Navbar

The API status url in the navbar can be modified in `_includes/nav.html`

### Thumbnails

At the top of the page, you may find small squares. You can create them using the tag `thumbnail: true` in the mardown files. You can have as many as you like.

## Style

If you want to modify the style, have a look at `_sass/layout.scss`. At the top, you will find variables that control most of the colors.