https://github.com/cyrilf/vuepress-theme-book

A VuePress theme inspired by Gitbook
https://github.com/cyrilf/vuepress-theme-book

gitbook theme vuepress vuepress-theme vuepress-themes

Last synced: 27 days ago
JSON representation

A VuePress theme inspired by Gitbook

• Host: GitHub
• URL: https://github.com/cyrilf/vuepress-theme-book
• Owner: cyrilf
• Created: 2020-04-11T15:45:56.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-22T14:33:23.000Z (about 1 month ago)
• Last Synced: 2024-11-22T15:33:11.752Z (about 1 month ago)
• Topics: gitbook, theme, vuepress, vuepress-theme, vuepress-themes
• Language: Stylus
• Homepage: https://vuepress-theme-book.netlify.app
• Size: 4.35 MB
• Stars: 118
• Watchers: 3
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# VuePress theme - Gitbook inspired

A [VuePress](https://vuepress.vuejs.org) theme inspired by [Gitbook](https://docs.gitbook.com/).

![screenshot](screenshot.png)

[Live demo](https://vuepress-theme-book.netlify.app)

I really love their clean and minimalist style, so I decided to do a theme for VuePress.

It is **not** 100% identical to a Gitbook page, some choices are made to respect VuePress limitations.

It is based on `@vuepress/theme-default` and I only extend it.

You can see a **live demo** on the [demo website](https://vuepress-theme-book.netlify.app)

## Using the Theme

If you want to use this theme on your own project, please refers to the Theme Readme.

### [Go to the Theme Readme](./packages/vuepress-theme-book/README.md)

## Websites using this theme:

- [The Wise Opportunist](https://opportunist.luseeds.com) by [luseeds](https://luseeds.com)

Want to add your website too? Send me a PR. :v:

## Developing:

This repo makes use of [yarn workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) to link packages together whilst developing.

This means you can run the demo dev tasks whilst developing the theme package and see latest theme changes on the demo site.

Here, you're at the entry point. You can find the demo under [packages/demo](./packages/demo) and the theme under [packages/vuepress-theme-book](./packages/vuepress-theme-book)

### Install dependencies

`yarn`

### Run demo site in development mode

`yarn develop`

### Build

`yarn build`

## If you like it, please STAR it

If you enjoy using it, please star it!

## Feedback

Feel free to create an [issue](https://github.com/cyrilf/vuepress-theme-book/issues).

## Contributing

I would be more than happy to receive feedback/issues/pull requests, so don't hesitate.

- Check the [open issues](https://github.com/cyrilf/vuepress-theme-book/issues) or [open a new issue](https://github.com/cyrilf/vuepress-theme-book/issues/new) to start a discussion around your feature idea or the bug you found.

- Fork [the repository](https://github.com/cyrilf/vuepress-theme-book), make changes and send a pull request

## License

[MIT](https://github.com/cyrilf/vuepress-theme-book/blob/master/LICENSE)

Thank you!