• Stars
    star
    150
  • Rank 241,594 (Top 5 %)
  • Language
    JavaScript
  • Created about 8 years ago
  • Updated over 7 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Theme for publishing a beautiful API documentation with GitBook

GitBook API Theme

Theme for using GitBook to publish an API documentation.

This theme works perfectly with search plugins (like the default plugin or algolia).

Screenshot

It also integrates well with the default fontsettings plugin to use the Dark theme.

Dark theme

Usage

This theme requires GitBook version 3 or later.

Add the theme to your book's configuration (book.json):

{
    "plugins": ["theme-api"]
}

To use the Dark theme by default:

{
    "plugins": ["theme-api"],
    "pluginsConfig": {
        "theme-api": {
            "theme": "dark"
        }
    }
}

Defining methods

The theme allows to easily define methods with examples for different languages, using the templating blocks syntax.

A method block can contain any number of nested sample and common blocks.

Those nested blocks are documented below.

Sample blocks

While the body of the method block will be used as the definition for your method, each sample will be used to display examples. To do so, each sample block should specify a language using the lang arguments.

This is great for managing examples in different languages, for instance when documenting multiple API clients.

{% method %}
## Install {#install}

The first thing is to get the GitBook API client.

{% sample lang="js" %}
```bash
$ npm install gitbook-api
```

{% sample lang="go" %}
```bash
$ go get github.com/GitbookIO/go-gitbook-api
```
{% endmethod %}

JS Sample Go sample

On each page containing method blocks with samples, a switcher is automatically added at the top-right corner to easily select which language to display.

The name of each language can be configured in your book.json file, with it's lang property corresponding to the sample block lang argument:

{
  "plugins": ["theme-api"],
  "pluginsConfig": {
    "theme-api": {
      "languages": [
        {
          "lang": "js",          // sample lang argument
          "name": "JavaScript",  // corresponding name to be displayed
          "default": true        // default language to show
        },
        {
          "lang": "go",
          "name": "Go"
        }
      ]
    }
  }
}

Language switcher

Most programming languages are supported by default, with name mapping following the highlight.js convention.

Note that a sample block can contain any markdown content to be displayed for this language, not only code blocks, as illustrated below.

Common blocks

Common blocks are used to display content to be displayed for all languages in your examples.

{% method %}
## Simple method

{% sample lang="js" %}
This text will only appear for JavaScript.

{% sample lang="go" %}
This text will only appear for Go.

{% common %}
This will appear for both JavaScript and Go.
{% endmethod %}

Layout

The theme provides two layouts to display your examples: one-column or two-columns (split).

One column layout

One column

Split layout

Split

The layout can be toggled from the toolbar using the layout icon: Layout icon

The default aspect can also be set in the theme configuration in the book.json file:

{
  "plugins": ["theme-api"],
  "pluginsConfig": {
    "theme-api": {
      "split": true
    }
  }
}

More Repositories

1

gitbook

The open source frontend for GitBook doc sites
TypeScript
26,513
star
2

javascript

GitBook teaching programming basics with Javascript
3,322
star
3

nuts

🌰 Releases/downloads server with auto-updater and GitHub as a backend
JavaScript
1,242
star
4

gitbook-cli

GitBook's command line interface
JavaScript
707
star
5

git

ProGit Book Fork generated using GitBook
306
star
6

markup-it

JavaScript library to parse and serialize markup content (Markdown and HTML)
JavaScript
268
star
7

markdown

Learn how to use Markdown
242
star
8

kramed

A markdown (kramdown compatible) parser and compiler. Built for speed. (Fork of marked)
HTML
224
star
9

theme-default

Default theme for GitBook
JavaScript
195
star
10

rousseau

Lightweight proofreader in JS
JavaScript
179
star
11

community

GitBook's official community page
107
star
12

gitbook-convert

CLI to convert an existing document to a GitBook.
JavaScript
101
star
13

slate-edit-table

Slate plugin for table edition
JavaScript
101
star
14

slate-edit-list

A Slate plugin to handle keyboard events in lists.
JavaScript
94
star
15

proxies-on-cloudflare

Proxies in Cloudflare Workers
TypeScript
93
star
16

plugin-mathjax

MathJAX plugin for GitBook
JavaScript
89
star
17

plugin-autocover

Generate a cover for the book
JavaScript
87
star
18

styleguide

GitBook.com HTML/CSS Style Guide
JavaScript
86
star
19

repofs

Simple and unified API to manipulate Git repositories
JavaScript
77
star
20

hunspell-spellchecker

Parse and use Hunspell dictionaries in Javascript
JavaScript
77
star
21

micro-analytics

A micro multi-website analytics database service designed to be fast and robust, built with Go and SQLite.
Go
76
star
22

plugin

Sample plugin for GitBook
JavaScript
66
star
23

integrations

Toolkit to build integrations on GitBook
TypeScript
62
star
24

filterable

Parse and convert GitHub-like search queries in Node.JS
JavaScript
61
star
25

example

Simple GitBook example
59
star
26

plugin-katex

Math typesetting using KaTex
JavaScript
59
star
27

plugin-exercises

Interactive exercices in a gitbook
JavaScript
56
star
28

react-rich-diff

React component to render rich diff between two documents (Markdown, HTML)
JavaScript
52
star
29

plugin-disqus

Disqus comments on your books
JavaScript
51
star
30

plugin-ga

Google Analytics tracking for your book
JavaScript
51
star
31

git-sync-normalization

A repository that shows how we translate every content block to markdown.
50
star
32

slate-edit-code

A Slate plugin for code block editing
JavaScript
43
star
33

theme-faq

Theme for publishing a FAQ or Knowledge base
HTML
38
star
34

node-gitbook-api

Node client library for the GitBook API
JavaScript
36
star
35

plugin-youtube

Plugin to insert youtube videos in a GitBook
JavaScript
33
star
36

tokenize-text

Javascript text tokenizer that is easy to use and compose.
JavaScript
30
star
37

slate-prism

A Slate plugin to highlight code blocks using PrismJS
JavaScript
27
star
38

plugin-quizzes

Interactive quizzes in a gitbook
JavaScript
26
star
39

plugin-search

Search content in your book
JavaScript
25
star
40

plugin-codetabs

Multiple languages code blocks for GitBook
JavaScript
25
star
41

plugin-algolia

Power search using Algolia
JavaScript
25
star
42

theme-official

GitBook theme for our own books
HTML
25
star
43

go-gitbook-api

GitBook API client in GO (golang)
Go
24
star
44

plugin-github

Display a link to your GitHub repo in your gitbook
JavaScript
24
star
45

slate-hyperprint

A library to convert Slate models to their slate-hyperscript representation
JavaScript
24
star
46

plugin-hints

GitBook plugin. Defines 4 types of styled hint blocks: info, danger, tip, working
JavaScript
23
star
47

expect-firestore

API client and Jasmine matchers for the Firestore Rules API
JavaScript
22
star
48

plugin-puml

UML Diagrams rendering using PlantUML
JavaScript
21
star
49

go-github-webhook

A GitHub webhook handler written in Go
Go
21
star
50

node-opds

Node.js library to parse/generate OPDS feed
JavaScript
21
star
51

plugin-comment

Inline discussions integrated with gitbook.com
JavaScript
20
star
52

node-onix

Node.JS library to parse/generate ONIX XML files
JavaScript
18
star
53

slate-sugar

🍭 Create Slate documents using JSX.
JavaScript
17
star
54

bipbip

Benchmark runner for performance regression test suites
JavaScript
17
star
55

slate-lite-renderer

Fast renderer for read-only Slate documents
JavaScript
16
star
56

plugin-fontsettings

Font settings for GitBook website
CSS
16
star
57

github-api-signature

Node.js signature generator for GitHub API using a PGP key
TypeScript
15
star
58

isbn-utils

Javascript utilities to parse and normalize ISBNs
JavaScript
15
star
59

plugin-versions

Display a <select> with other versions of your gitbook
JavaScript
15
star
60

markdown-css

Minimalist stylesheet (CSS or Less) for markup output
CSS
14
star
61

plugin-scripts

Include scripts in your GitBook
JavaScript
14
star
62

plugin-sharing

Sharing button in toolbar for GitBooks
JavaScript
14
star
63

tokenize-english

Javascript tokenizer for english sentences
JavaScript
14
star
64

diskache

Lightweight Golang disk cache
Go
13
star
65

mimedb

An extensive mime database in Go
Go
13
star
66

DraftMirror

Draft.js-like API on top of ProseMirror
JavaScript
13
star
67

normall

Normall: normalize filenames, accents etc ... in JS
JavaScript
13
star
68

plugin-highlight

Default syntax highlighter for GitBook
CSS
12
star
69

unstated

Simple state management for react
TypeScript
12
star
70

services-slack

Slack notifications service
JavaScript
12
star
71

plugin-gist

Embed Gist in your book
JavaScript
10
star
72

monorepo

A big home for small repos
Go
10
star
73

slate-edit-footnote

A Slate plugin to handle footnotes
JavaScript
10
star
74

lru-diskcache

A disk cache object that deletes the least-recently-used items
JavaScript
10
star
75

slate-edit-blockquote

A Slate plugin to handle keyboard events in blockquotes
JavaScript
10
star
76

plugin-styles-sass

SASS custom stylesheets instead of CSS
JavaScript
9
star
77

node-epubcheck

Node wrapper for epubcheck
JavaScript
9
star
78

plugin-lunr

Backend for the search plugin using Lunr
JavaScript
9
star
79

geo-utils

Utilities to get countries, languages and US states
JavaScript
9
star
80

slate-trailing-block

Slate plugin to ensure a trailing block
JavaScript
9
star
81

eslint-config-gitbook

GitBook's ESLint config, following our styleguide
JavaScript
9
star
82

go-sqlpool

A high level pool for maintaining pools of *sql.DB databases (e.g: thousands of SQLite files)
Go
9
star
83

syncgroup

Like golang's sync package but allows locking per groups of (string) keys (e.g: syncgroup.MutexGroup)
Go
9
star
84

public-docs

9
star
85

plugin-infinitescroll

Infinite scrolling in your gitbook
JavaScript
8
star
86

node-tasqueue

Node.js job/task-queue library using disque
JavaScript
8
star
87

plugin-livereload

Live reloading for your gitbook
JavaScript
8
star
88

plugin-tonic

Embed Tonic notebook into your GitBook
JavaScript
8
star
89

markdown-tools

A small CLI interface to kramed with lots of useful markdown tools (like go's "go fmt", lexing, rendering ...)
JavaScript
8
star
90

openapi-autodoc

Generate a GitBook Space from an OpenAPI spec
JavaScript
8
star
91

slate-no-empty

Slate plugin to prevent the document from being empty
JavaScript
8
star
92

plugin-mixpanel

Mixpanel tracking for your gitbook
JavaScript
7
star
93

brightml

Smart utility rendering markdown-ready HTML
JavaScript
7
star
94

html2hs

Convert HTML to hyperscript for virtual-dom
JavaScript
7
star
95

kramed-text-renderer

Renderer for kramed outputting plain text that can easily be fed to a search indexer/tokenizer/...
JavaScript
7
star
96

plugin-sitemap

Generate a sitemap for the gitbook website
JavaScript
7
star
97

firebase-apparatus

Lightweight implementation of firebase-tools as a Node module
TypeScript
7
star
98

licenses-utils

Utilities to detect licenses from project
JavaScript
7
star
99

example-visitor-authentication

Minimalist NodeJS application for "Visitor Authentication"
JavaScript
7
star
100

plugin-superscript

Use superscript in your content
JavaScript
6
star