https://gitlab.com/lramage/mkdocs-gitbook-theme

Default theme for GitBook for Mkdocs https://lramage.gitlab.io/mkdocs-gitbook-theme
https://gitlab.com/lramage/mkdocs-gitbook-theme

gitbook mkdocs theme

Last synced: about 1 month ago
JSON representation

Default theme for GitBook for Mkdocs https://lramage.gitlab.io/mkdocs-gitbook-theme

• Host: gitlab.com
• URL: https://gitlab.com/lramage/mkdocs-gitbook-theme
• Owner: lramage
• License: apache-2.0
• Created: 2018-12-17T18:29:14.483Z (almost 6 years ago)
• Default Branch: master
• Last Synced: 2024-09-30T08:01:24.697Z (about 2 months ago)
• Topics: gitbook, mkdocs, theme
• Stars: 28
• Forks: 13
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mkdocs - GitBook Theme

[![Apache 2.0 License][apache-badge]](LICENSE)

[![PyPI][pypi-badge]][pypi-ref]

## Installation

First, install the package via PyPI:

```sh

pip install mkdocs-gitbook

```

Then include the theme in your `mkdocs.yml` file:

```yaml

theme:

  name: gitbook

```

## Motivation

Gitbook was a static-site generator written in JavaScript.

Mkdocs is a static-site generator written in Python.

**Gitbook is [no longer a static-site generator][1], [nor does it use git][2], nor is it [free][3] or [open source][4]!**

[1]: https://docs.gitbook.com/v2-changes/important-differences#cli-toolchain

[2]: https://docs.gitbook.com/v2-changes/important-differences#git-hosting-and-integration

[3]: https://www.gnu.org/philosophy/free-sw.html

[4]: https://opensource.org/osd

[apache-badge]: https://img.shields.io/badge/license-Apache--2.0-blue.svg?style=flat-square

[pypi-badge]: https://img.shields.io/pypi/v/mkdocs-gitbook.svg?style=flat-square

[pypi-ref]: https://pypi.python.org/pypi/mkdocs-gitbook

## Screenshot



## License

SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)