{"id":15021024,"url":"https://github.com/vaibhavvikas/jekyll-theme-minimalistic","last_synced_at":"2025-05-07T07:21:45.031Z","repository":{"id":40490667,"uuid":"507258644","full_name":"vaibhavvikas/jekyll-theme-minimalistic","owner":"vaibhavvikas","description":"A minimal responsive Jekyll theme with navigation in the sidebar and many more amazing features. ","archived":false,"fork":false,"pushed_at":"2023-07-15T05:04:53.000Z","size":469,"stargazers_count":43,"open_issues_count":0,"forks_count":51,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-03T18:47:24.454Z","etag":null,"topics":["blog-theme","gh-pages","github-pages","jekyll","jekyll-theme","minimal","minimalistic","ruby"],"latest_commit_sha":null,"homepage":"https://vaibhavvikas.github.io/jekyll-theme-minimalistic/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vaibhavvikas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2022-06-25T08:40:22.000Z","updated_at":"2025-03-26T15:56:28.000Z","dependencies_parsed_at":"2024-09-14T17:07:32.052Z","dependency_job_id":"b04027e6-201e-4343-9d81-accb978e8240","html_url":"https://github.com/vaibhavvikas/jekyll-theme-minimalistic","commit_stats":{"total_commits":55,"total_committers":1,"mean_commits":55.0,"dds":0.0,"last_synced_commit":"cd60a5adf819934fda331868f3b0e3ff8fb98ef8"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fjekyll-theme-minimalistic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fjekyll-theme-minimalistic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fjekyll-theme-minimalistic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fjekyll-theme-minimalistic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vaibhavvikas","download_url":"https://codeload.github.com/vaibhavvikas/jekyll-theme-minimalistic/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252831462,"owners_count":21810808,"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":["blog-theme","gh-pages","github-pages","jekyll","jekyll-theme","minimal","minimalistic","ruby"],"created_at":"2024-09-24T19:56:02.460Z","updated_at":"2025-05-07T07:21:45.008Z","avatar_url":"https://github.com/vaibhavvikas.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jekyll-theme-minimalistic\n\n[![Featured](https://img.shields.io/badge/featured%20on-JekyllThemes-red.svg)](https://jekyll-themes.com/jekyll-theme-minimalistic/)\n[![GitHub top language](https://img.shields.io/github/languages/top/vaibhavvikas/jekyll-theme-minimalistic)](#)\n[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/vaibhavvikas/jekyll-theme-minimalistic)](#)\n[![GitHub stars](https://img.shields.io/github/stars/vaibhavvikas/jekyll-theme-minimalistic)](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/stargazers)\n[![Ruby Gem](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/gem-push.yml/badge.svg)](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/gem-push.yml)\n[![pages-build-deployment](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/pages/pages-build-deployment)\n\n\nMinimalistic theme is based on gh-pages minimal theme, with navigation in the sidebar and super amazing features. Wanna see it in action? You can view a live demo at [Minimalistic](https://vaibhavvikas.github.io/jekyll-theme-minimalistic/).\n\n![Screenshot](https://user-images.githubusercontent.com/28614457/179896288-56255d9e-946a-4566-aca4-85459d403ff9.png)\n\n## Features\n1. Auto light/dark mode.\n2. Syntax Highlighting for light/dark mode.\n3. Logo Support for the page.\n4. Links in Sidebar.\n5. List/Sublist in Sidebar.\n6. Fully responsive with mobile support.\n7. Logo/Favicon Support.\n8. Github-Pages Support.\n9. Card Support\n10. Under active development.\n11. And many more. 😁\n\n## Usage\n\nYou can refer to this [Wiki Link](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/wiki) if you want to use this theme for creating github pages for your own custom repository.\n\nTo use the Minimalistic theme:\n\n1. Add the following line to your Gemfile\n\n```ruby\ngem \"jekyll-remote-theme\"\n```\n\nthen run `bundle install` to install the plugin.\n\n2. Add the following to your site's `_config.yml` to activate the plugin:\n\n```yml\nplugins:\n  - jekyll-remote-theme\n```\n\nNote: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.\n\n1. Add the following line to your `config.yml` to use the theme\n\n```yml\nremote_theme: vaibhavvikas/jekyll-theme-minimalistic\n```\n\nthen running `bundle exec jekyll serve` for local deployment.\n\n## Customizing\n\n### Configuration variables\n\nMinimalistic will respect the following variables, if set in your site's `_config.yml`:\n\n```yml\ntitle: [The title of your site]\ndescription: [A short description of your site's purpose]\n```\n\nAdditionally, you may choose to set the following optional variables:\n\n```yml\ngoogle_analytics: [Your Google Analytics tracking ID]\n```\n\nChoose light, dark, or automatically adjusting theme based on system theme:\n\n```yml\ncolor-scheme: auto/light/dark\n```\n\nSpecify logo for the website:\n\n```yml\nlogo: /assets/img/\u003clogo_file\u003e\n```\n\nEnable favicon by putting a `favicon.ico` in the repo's root directory and add the following line in `config.yml`:\n\n```yml\nfavicon: true\n```\n\n### Customizing Sidebar\n\nYou can define a list of platforms that are linked from the sidebar in `_config.yml`:\n\n```yml\nplatforms:\n  - name: GitHub\n    icon: \u003ci class=\"fa-brands fa-github\"\u003e\u003c/i\u003e\n    link: https://github.com/vaibhavvikas\n  - name: LinkedIn\n    icon: \u003ci class=\"fa-brands fa-linkedin\"\u003e\u003c/i\u003e\n    link: https://www.linkedin.com/in/vaibhavvikas\n  - ...\n```\n\n### Navigation\n\nYou can also define, hyperlinks for specific pages or section of a pages (very helpful if creating multipage documentation or easy navigation between multiple sections). \n\nFor adding navigation do the following steps:\n\n1. Put your .md files in the root directory. and add the below text on top of pages to get it converted to html by jekyll.\n   \n```yml\n---\nlayout: default\n---\n```\n\n2. Use the navigation example below to add navigation section in _config.yml file. Treat all your .md files as .html files. Currently it only supports one nesting in sublist.\n\n```yml\nnavigation:\n  - name: Readme\n    link: ./index.html\n    sublist:\n      - name: Image\n        link: ./index.html#small-image\n  - name: Another Page\n    link: ./another-page.html\n  - ...\n```\n\n### Example:\n\n[Live Example](https://vaibhavvikas.github.io/jekyll-theme-minimalistic/)\\\n[Code used in GitHub page](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/tree/gh-pages)\n\nLets say you have a file name xyz.md, you put that into the root dir. Now, add the text in step 1 at the top of the md file. After that for the text in _config.yml you will put it like:\n\n```yml\nnavigation:\n  - name: [Write name of your hyperlink]\n    link: ./xyz.html\n```\n\n### Adding Card:\n\nUse the code template:\n```html\n\u003cdiv class=\"card\"\u003e\n  \u003ch3\u003eSome Title\u003c/h3\u003e\n  \u003cp\u003e\u003cb\u003eNew Delhi\u003c/b\u003e, India\u003cbr\u003e\n  Some Text\u003c/p\u003e\n  \u003ca href=\"https://vaibhavvikas.ml/\"\u003e\u003cspan class=\"card-link-spanner\"\u003e\u003c/span\u003e\u003c/a\u003e\n\u003c/div\u003e\n```\n\n### Stylesheet\n\nIf you'd like to add your own custom styles:\n\n1. Create a file called `/assets/css/style.scss` in your site\n2. Add the following content to the top of the file, exactly as shown:\n\n    ```scss\n    ---\n    ---\n\n    @import \"{{ site.theme }}\";\n    ```\n\n3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line\n\n*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*\n\n### Customizing Google Analytics code\n\nGoogle has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site.\n\n## Previewing the theme locally\n\nIf you'd like to preview the theme locally (for example, in the process of proposing a change):\n\n1. Clone down the theme's repository (`git clone https://github.com/vaibhavvikas/jekyll-theme-minimalistic`)\n2. `cd` into the theme's directory\n3. Run `script/bootstrap` to install the necessary dependencies\n4. Run `bundle exec jekyll serve` to start the preview server\n5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme\n\n## Running tests\n\nThe theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` once before the test script will work.\n\n## Contributors\n\nAll contributions and suggestions are welcome.\n\n## Credits:\n\nThis theme was built using [Minimalist](https://github.com/BDHU/minimalist) theme by BDHU and [Minimal](https://github.com/pages-themes/minimal) by GithHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaibhavvikas%2Fjekyll-theme-minimalistic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvaibhavvikas%2Fjekyll-theme-minimalistic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaibhavvikas%2Fjekyll-theme-minimalistic/lists"}