{"id":13713256,"url":"https://github.com/BYR-Navi/BYR-Navi","last_synced_at":"2025-05-06T23:31:29.030Z","repository":{"id":43040612,"uuid":"69995498","full_name":"BYR-Navi/BYR-Navi","owner":"BYR-Navi","description":"A Light-Weight and Configurable Navigation Website Framework (for BYR)","archived":false,"fork":false,"pushed_at":"2024-08-01T15:05:18.000Z","size":9503,"stargazers_count":520,"open_issues_count":0,"forks_count":208,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-11-14T00:33:45.349Z","etag":null,"topics":["byr","byr-navi","irockbunny","navigation","navigation-website","website"],"latest_commit_sha":null,"homepage":"https://byr-navi.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BYR-Navi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://byr-navi.com/donate/"}},"created_at":"2016-10-04T18:45:53.000Z","updated_at":"2024-09-17T01:48:50.000Z","dependencies_parsed_at":"2023-12-19T06:57:21.024Z","dependency_job_id":"0c918b96-c7ba-469b-baff-ca8a24bcbc13","html_url":"https://github.com/BYR-Navi/BYR-Navi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BYR-Navi%2FBYR-Navi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BYR-Navi%2FBYR-Navi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BYR-Navi%2FBYR-Navi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BYR-Navi%2FBYR-Navi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BYR-Navi","download_url":"https://codeload.github.com/BYR-Navi/BYR-Navi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252787478,"owners_count":21804266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["byr","byr-navi","irockbunny","navigation","navigation-website","website"],"created_at":"2024-08-02T23:01:30.872Z","updated_at":"2025-05-06T23:31:24.021Z","avatar_url":"https://github.com/BYR-Navi.png","language":"JavaScript","funding_links":["https://byr-navi.com/donate/"],"categories":["JavaScript"],"sub_categories":[],"readme":"[![Build Status](https://img.shields.io/travis/com/BYR-Navi/BYR-Navi?logo=travisci)][travis-ci]\n[![Website](https://img.shields.io/website?url=http%3A%2F%2Fbyr-navi.com\u0026logo=linode)][website]\n[![License](https://img.shields.io/github/license/BYR-Navi/BYR-Navi)][license]\n[![Last Commit](https://img.shields.io/github/last-commit/BYR-Navi/BYR-Navi?logo=github)][commit]\n[![Donate](https://img.shields.io/badge/Donate-Coffee-A5673F?logo=buymeacoffee)][donate]\n\n# \u003cimg height=\"32\" src=\"https://byr-navi.com/images/logo-dark.svg\" alt=\"Icon\" /\u003e BYR-Navi\nA Light-Weight and Configurable Navigation [Website][website] Framework (for BYR)\n\n## :triangular_ruler: Design Philosophy\nThis project is a [Jekyll][jekyll]-powered website, which is built based on [Fomantic UI][fomantic] web framework, and deployed **previously** using [GitHub Pages][github-pages] (while currently running on a [Linode][linode] VPS).\n\nThe whole project is designed and built with high flexibility of configuration and customization.\nYou 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.\n\n## :book: A Tiny Tutorial\nThere is **no easy way for beginners** without essential background knowledge.\nTo be efficient, the best way to understand this project is to start with the Jekyll\u0026rsquo;s [docs][jekyll-doc] and Fomantic UI\u0026rsquo;s [docs][fomantic-doc].\n\nBefore you start, you should have some basic understanding of the following:\n\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/html5.svg\" alt=\"Icon\" /\u003e HTML\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/css3.svg\" alt=\"Icon\" /\u003e CSS\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/javascript.svg\" alt=\"Icon\" /\u003e JavaScript\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/jquery.svg\" alt=\"Icon\" /\u003e jQuery\n- YAML format\n- [Liquid][liquid] (Template Engine by \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/shopify.svg\" alt=\"Icon\" /\u003e Shopify)\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/ruby.svg\" alt=\"Icon\" /\u003e Ruby\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/linux.svg\" alt=\"Icon\" /\u003e UNIX/Linux Shell Script\n\n### Quick Start\n\n1. Install a full [Ruby development environment][jekyll-installation].\n\n2. Install Jekyll and [bundler][jekyll-ruby-101-bundler] [gems][jekyll-ruby-101-gems].\n\n```sh\ngem install jekyll bundler\n```\n\n3. Clone the project from GitHub.\n\n```sh\ngit clone https://github.com/BYR-Navi/BYR-Navi.git\n```\n\n4. Change into the project directory.\n\n```sh\ncd BYR-Navi\n```\n\n5. Install required gems in the `Gemfile` using Bundler.\n\n```sh\nbundle install\n```\n\n6. Build the site and make it available on a local server.\n\n```sh\nbundle exec jekyll serve\n```\n\n7. Now browse to [http://localhost:4000][localhost-4000].\n\n## :construction: Deployment\n\n### GitHub Pages (Recommended)\nSites on GitHub Pages are powered by Jekyll behind the scenes, so if you\u0026rsquo;re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to [host your Jekyll-powered website for free][jekyll-gihub-pages].\n\n### Manual Deployment\nJekyll 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.\n[Here][jekyll-manual-deployment] are some manual ways of achieving this.\n\n## :hearts: Share the Love\nI\u0026rsquo;ve put a lot of time and effort into making **BYR-Navi** awesome.\nIf you love it, you can buy me a coffee.\nEvery cup helps!\nI promise it will be a good investment.\n\nDonate [here][donate].\n\n## :rocket: Powered by\n- [Fomantic UI][fomantic]\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/jquery.svg\" alt=\"Icon\" /\u003e [jQuery][jquery]\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/shieldsdotio.svg\" alt=\"Icon\" /\u003e [Shields.io][shields]\n- [Day.js][day]\n- [CountUp.js][countup]\n- [jQuery.countdown][countdown]\n- [JavaScript Cookie][js-cookie]\n- [url.js][js-url]\n- [UNPKG][unpkg]\n- [Hitokoto][hitokoto]\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/apacheecharts.svg\" alt=\"Icon\" /\u003e [ECharts][echarts]\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/matomo.svg\" alt=\"Icon\" /\u003e [Matomo][matomo]\n- [GeoIP][geoip]\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/jekyll.svg\" alt=\"Icon\" /\u003e [Jekyll][jekyll]\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/letsencrypt.svg\" alt=\"Icon\" /\u003e [Let\u0026rsquo;s Encrypt][letsencrypt]\n- \u003cimg height=\"16\" src=\"https://unpkg.com/simple-icons/icons/linode.svg\" alt=\"Icon\" /\u003e [Linode][linode]\n\n## :copyright: License\n[MIT License][license]\n\n[travis-ci]: https://app.travis-ci.com/BYR-Navi/BYR-Navi \"Travis CI\"\n[website]: https://byr-navi.com/ \"Website\"\n[license]: https://github.com/BYR-Navi/BYR-Navi/blob/master/LICENSE \"License\"\n[commit]: https://github.com/BYR-Navi/BYR-Navi/commits/master \"Last Commit\"\n[donate]: https://byr-navi.com/donate/ \"Donate\"\n\n[fomantic]: https://fomantic-ui.com/ \"Fomantic UI\"\n[fomantic-doc]: https://fomantic-ui.com/introduction/getting-started.html \"Fomantic UI Docs\"\n[jquery]: https://jquery.com/ \"jQuery\"\n[shields]: https://shields.io/ \"Shields.io\"\n[day]: https://github.com/iamkun/dayjs \"Day.js\"\n[countup]: https://inorganik.github.io/countUp.js/ \"CountUp.js\"\n[countdown]: https://hilios.github.io/jQuery.countdown/ \"The Final Countdown plugin for jQuery\"\n[js-cookie]: https://github.com/js-cookie/js-cookie \"JavaScript Cookie\"\n[js-url]: https://github.com/websanova/js-url \"url.js\"\n[unpkg]: https://unpkg.com/ \"UNPKG\"\n[hitokoto]: https://hitokoto.cn/api \"Hitokoto\"\n[echarts]: https://echarts.apache.org/ \"ECharts\"\n[matomo]: https://matomo.org/ \"Matomo\"\n[geoip]: https://www.maxmind.com/ \"GeoIP\"\n[jekyll]: https://jekyllrb.com/ \"Jekyll\"\n[jekyll-doc]: https://jekyllrb.com/docs/home/ \"Jekyll Docs\"\n[jekyll-installation]: https://jekyllrb.com/docs/installation/ \"Jekyll Installation\"\n[jekyll-gihub-pages]: https://jekyllrb.com/docs/github-pages/ \"Jekyll GitHub Pages\"\n[jekyll-manual-deployment]: https://jekyllrb.com/docs/deployment/manual/ \"Jekyll Manual Deployment\"\n[jekyll-ruby-101-gems]: https://jekyllrb.com/docs/ruby-101/#gems \"Jekyll Ruby 101 Gems\"\n[jekyll-ruby-101-bundler]: https://jekyllrb.com/docs/ruby-101/#bundler \"Jekyll Ruby 101 Bundler\"\n[liquid]: https://shopify.github.io/liquid/ \"Liquid\"\n[localhost-4000]: http://localhost:4000 \"Local Host (Port: 4000)\"\n[github-pages]: https://pages.github.com/ \"GitHub Pages\"\n[letsencrypt]: https://letsencrypt.org/ \"Let\u0026rsquo;s Encrypt\"\n[linode]: https://www.linode.com/ \"Linode\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBYR-Navi%2FBYR-Navi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBYR-Navi%2FBYR-Navi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBYR-Navi%2FBYR-Navi/lists"}