bootstrap-template is a basic template repository to create a Bootstrap 4 site using Jekyll on GitHub Pages (or where every you want to host it). The layout is based on the Bootstrap starter template example with a navbar, search box (using lunr.js), and footer. It is intended as a quick starting point for creating new web projects.
Demo: https://thecdil.github.io/bootstrap-template/
Please note: this template uses Bootstrap 4. For most recent version check bootstrap5-template.
- Click green "Use this template" button to make a copy of the code in your own repository (alternatively, use Import or manually copy files)
- Edit
_config.ymlwith your site information - In your new repository visit "Settings" > "Pages" to activate GitHub Pages
- Edit and create pages in the "pages" folder (probably in Markdown). Use each page's yaml front matter to populate the navbar:
titlewill appear as h1 at top of the page content.navif this option has a value, it will appear in the navbar as link to this page.nav_ordernavbar items will be sorted using this number.
- Use "includes" to simplify adding Bootstrap features to Markdown pages (see comments in the "_include/" files for instructions).
See docs/create-website.md for more details.
- Tweak base variables in
assets/css/main.scss(text color, link color, container size) - Tweak bootstrap theme colors using
_data/theme-colors.csv(add a css color in the color column next to the BS color-class to override, or create a new class name. This will generate btn-, text-, and bg- classes.) - Add custom CSS to
_sass/_custom.scss(content of_sass/_template.scssrelates to template components) - Use Bootstrap to customize
_layouts/and_includes/template/.
Included in assets/lib folder:
- Bootstrap 4.6
- JQuery 3.6.0
- Bootstrap Icons 1.1.0
- lunr.js 2.3.9