https://github.com/dalezak/vitepress-bootstrap
Vitepress Bootstrap Theme
https://github.com/dalezak/vitepress-bootstrap
bootstrap bootstrap5 vitepress vue vue3
Last synced: about 2 months ago
JSON representation
Vitepress Bootstrap Theme
- Host: GitHub
- URL: https://github.com/dalezak/vitepress-bootstrap
- Owner: dalezak
- License: mit
- Created: 2024-09-02T20:06:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T21:00:04.000Z (over 1 year ago)
- Last Synced: 2025-09-10T05:58:51.996Z (10 months ago)
- Topics: bootstrap, bootstrap5, vitepress, vue, vue3
- Language: Vue
- Homepage: https://dalezak.github.io/vitepress-bootstrap/
- Size: 135 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vitepress Bootstrap
Static site generator using markdown for content built with Vitepress and Bootstrap
Customizable turn key starter theme with responsive layout, dark mode, video player, photo gallery, and more
---
### Frontmatter
Easily write content for your pages using YAML [frontmatter](https://vitepress.dev/guide/frontmatter) in your markdown.
- **id** - page slug
- **title** - page title
- **date** - date
- **year** - year
- **keywords** - comma separated list of keywords
- **link** - single url
- **links** - list of urls
- **image** - single image url
- **images** - list of image urls
- **audio** - url to MP3 audio file
- **video** - url to YouTube
- **repo** - url to Github repo
- **isbn** - book ISBN number
- **description** - page description
---
### Configuration
Easily custom your site configuration by editing options in [.vitepress/config.mjs](https://github.com/dalezak/vitepress-bootstrap/blob/main/.vitepress/config.mjs).
- **title** - site title
- **description** - site description
- **cleanUrls** - `true`, `false`
- **base** - site path, Github Pages is project name, custom domain is `/`
- **themeConfig.author** - your name or organization
- **themeConfig.website** - website url
- **themeConfig.layout** - `default`
- **themeConfig.theme** - `light`, `dark`
- **themeConfig.font** - any font family from [Google Fonts](https://fonts.google.com)
- **themeConfig.container** - `container`, `container-fluid`
- **themeConfig.navbar** - `top`, `fixed-top`, `fixed-bottom`, `sticky-top`, `sticky-bottom`
- **themeConfig.footer** - `visible`, `hidden`
- **themeConfig.sidebar** - `visible`, `hidden`
- **themeConfig.search** - `visible`, `hidden`
- **themeConfig.breadcrumbs** - `visible`, `hidden`
- **themeConfig.share** - `visible`, `hidden`
- **themeConfig.variables** - override any [Bootstrap](https://getbootstrap.com) variables
- **themeConfig.links** - navbar links
- **themeConfig.feeds** - rss and atom feeds
- **themeConfig.networks** - social network links
---
### Theme
The theme is built using [Bootstrap](https://getbootstrap.com), you can override the default styling by editing any of the stylesheets in [.vitepress/theme](https://github.com/dalezak/vitepress-bootstrap/blob/main/.vitepress/theme).
---
### Start
Getting started is easy, simply follow the steps:
- fork [dalezak/vitepress-bootstrap](https://github.com/dalezak/vitepress-bootstrap)
- edit [.vitepress/config.mjs](https://github.com/dalezak/vitepress-bootstrap/blob/main/.vitepress/config.mjs)
- create your markdown content
You can follow the [features](https://github.com/dalezak/vitepress-bootstrap/features) for examples using different components like video player or image gallery.
---
### Dev
```shell
npm run dev
```
### Build
```shell
npm run build
```