A Light-Weight and Configurable Navigation Website Framework (for BYR)
📐 Design Philosophy
The whole project is designed and built with high flexibility of configuration and customization.
You can either configure it by modifying the
_config.yml file or customize it by replacing the content of the
*.yml files in the
_data folder with your own data.
📖 A Tiny Tutorial
Before you start, you should have some basic understanding of the following:
- YAML format
- Liquid (Template Engine)
- UNIX/Linux Shell Script
gem install jekyll bundler
- Clone the project from GitHub.
git clone https://github.com/BYR-Navi/BYR-Navi.git
- Change into the project directory.
- Install required gems in the
- Build the site and make it available on a local server.
bundle exec jekyll serve
- Now browse to http://localhost:4000.
GitHub Pages (Recommended)
Sites on GitHub Pages are powered by Jekyll behind the scenes, so if you’re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to host your Jekyll-powered website for free.
Jekyll generates your static site to the
_site directory by default. You can transfer the contents of this directory to almost any hosting provider to get your site live.
Here are some manual ways of achieving this.
♥️ Share the Love
I’ve put a lot of time and effort into making BYR-Navi awesome. If you love it, you can buy me a coffee. Every cup helps! I promise it will be a good investment.
🚀 Powered by
- Fomantic UI
- Let’s Encrypt