Skip to content

Commit

Permalink
sas
Browse files Browse the repository at this point in the history
  • Loading branch information
imswarnil committed Jul 3, 2024
1 parent 42d2070 commit 59aacf0
Show file tree
Hide file tree
Showing 8 changed files with 466 additions and 20 deletions.
6 changes: 6 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ exclude:
- vendor/gems/
- vendor/ruby/

# 14. Collections
collections:
docs:
output: true


# Include these directories and files in the `_site` output
include:
- _pages
Expand Down
92 changes: 92 additions & 0 deletions _data/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
- label: Getting Started
icon: fas fa-rocket
items:
- name: Installation
link: /docs/getting-started/installation/
- name: Upgrading to v1
link: /docs/getting-started/upgrading-to-v1/
- name: Configuration
link: /docs/getting-started/configuration/
- name: Theming
link: /docs/getting-started/theming/
- name: Sidebar
link: /docs/getting-started/sidebar/
- name: Scripts
link: /docs/getting-started/scripts/

- label: Navigation
icon: fas fa-compass
items:
- name: Top navigation
link: /docs/navigation/top-navigation/
- name: Footer navigation
link: /docs/navigation/footer-navigation/
- name: Menubar
link: /docs/navigation/menubar/

- label: Pages
icon: fas fa-file-alt
items:
- name: Creating a page
link: /docs/pages/creating-a-page/
- name: Hero
link: /docs/pages/hero/
- name: Table of Contents
link: /docs/pages/table-of-contents/

- label: Posts
icon: fas fa-pen-nib
items:
- name: Creating a Post
link: /docs/posts/creating-a-post/
- name: Excerpt & Summary
link: /docs/posts/post-excerpt-summary/
- name: Series
link: /docs/posts/post-series/

- label: Page Components
icon: fas fa-puzzle-piece
items:
- name: Callouts
link: /docs/page-components/callouts/
- name: Cookie Banner
link: /docs/page-components/cookie-banner/
- label: Image Gallery
icon: fas fa-image
items:
- name: Page
link: /docs/page-components/page/
- name: Cookie
link: /docs/page-components/cookie/
- name: Image Gallery
link: /docs/page-components/image-gallery/
- name: Image Modal
link: /docs/page-components/image-modal/
- name: Notifications
link: /docs/page-components/notifications/
- name: Showcases
link: /docs/page-components/showcases/
- name: Sponsors
link: /docs/page-components/sponsors/
- name: Tabs
link: /docs/page-components/tabs/
- name: Tags
link: /docs/page-components/tags/
- name: Video
link: /docs/page-components/video/

- label: Products
icon: fas fa-box-open
items:
- name: Product Pages
link: /docs/products/product-pages/
- name: Product Reviews
link: /docs/products/product-reviews/
- name: Category Page
link: /docs/products/category-page/

- label: Recipes
icon: fas fa-book-open
items:
- name: Recipes
link: /docs/recipes/recipes/
71 changes: 71 additions & 0 deletions _docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
layout: docs
title: Docs
permalink: /docs
menubar: docs
show_sidebar: false
---

# Welcome to Im-Jekyll-Theme Documentation

Welcome to the Im-Jekyll-Theme documentation. This guide is designed to help you make the most of the Im-Jekyll-Theme for your Jekyll projects. Whether you are a beginner or an experienced developer, you will find the information you need to get started and customize your theme.

## Table of Contents

- [Welcome to Im-Jekyll-Theme Documentation](#welcome-to-im-jekyll-theme-documentation)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Installation](#installation)
- [Configuration](#configuration)
- [Customization](#customization)
- [Using Bulma Components](#using-bulma-components)
- [Advanced Features](#advanced-features)
- [Troubleshooting](#troubleshooting)

## Introduction

Im-Jekyll-Theme is a clean, simple, minimalistic, and multipurpose theme made using Bulma for Jekyll. This theme is perfect for creating personal blogs, portfolios, documentation sites, and more.

## Installation

Find out how to install Im-Jekyll-Theme in your Jekyll project in the [Installation](/docs/getting-started/installation/) section.

## Configuration

Learn how to configure the theme to suit your needs. This section covers:
- Site settings
- Pagination
- Theme customization options
- Disqus comments setup

Check the detailed configuration guide in the [Configuration](/docs/configuration/) section.

## Customization

Customize the look and feel of your site by modifying styles and layouts. Topics covered include:
- Custom CSS and Sass
- Changing colors and fonts
- Modifying layouts and includes

Refer to the [Customization](/docs/customization/) section for more information.

## Using Bulma Components

Im-Jekyll-Theme leverages the Bulma CSS framework. Learn how to use various Bulma components such as buttons, cards, forms, and more in your site.

Explore the [Bulma Components](/docs/bulma-components/) section for examples and usage.

## Advanced Features

Unlock advanced features of the theme including:
- Adding plugins
- SEO optimization
- Using custom collections

Visit the [Advanced Features](/docs/advanced-features/) section to learn more.

## Troubleshooting

Encounter any issues? This section provides solutions to common problems and answers to frequently asked questions.

Check out the [Troubleshooting](/docs/troubleshooting
43 changes: 43 additions & 0 deletions _docs/pages/creating-a-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
layout: docs
title: Creating A Page
subtitle: Pages
menubar: docs_menu
toc: true
sidebar: false
---

## Creating A Page

Create your pages as individual Markdown files and when the site is built by Jekyll it will process the markdown into html.

You can create subdirectories with files in and they will have the subdirectory in their path. For example, this page is in the `docs` subdirectory and is called `creating-a-page.md`. This will become `/docs/creating-a-page.html`, or `/docs/creating-a-page/` depending on your permalink settings.

## Front Matter

Ensure you use `layout: page` for normal pages.

Set the page's title and subtitle in the front matter and it will appear in the hero. The subtitle is optional.

```yaml
layout: page
title: The page title
subtitle: The page subtitle
```
## Search Engine Optimisation
Bulma Clean Theme uses Jekyll SEO tag to generate additional meta tags. Ensure each page and post has a unique title and description in the front matter.
You can also set an image that will be used when the page or post is shared on social media.
```yaml
layout: page
title: The page title
subtitle: The page subtitle
description: This is the meta description for this page and will help it appear in search engines
image: /img/page-image.jpg
```
69 changes: 69 additions & 0 deletions _docs/pages/hero.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
layout: docs
title: Hero
subtitle: Pages
menubar: docs_menu
sidebar: false
redirect_from:
- /page-without-hero/
---

## Page Hero

A page can have a Bulma hero at the top of the page. This allows you to display the title and subtitle, as well as a background image.

## Background Image

Heros can display a background image if you provide a `hero_image: /path/to/image.jpg` setting in your page front matter.

```yaml
layout: page
title: My page
hero_image: /path/to/image.jpg
```
To set a default background image for all heros, you can set a [default value](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your site's `_config.yml`.

## Hero Height

You can set the height of the hero by providing a Bulma hero height class in your front matter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to `is-medium`.

```yaml
layout: page
title: My page
hero_height: is-fullwidth
```

## Call to action

If you would like to add a call to action button in the hero then add `hero_link` and `hero_link_text` to the page's front matter.

```yaml
layout: page
title: My page
hero_link: /my-page/
hero_link_text: The Link Text
```

## Hiding the Hero

If you would like to hide the hero on the page, you can set `hide_hero: true` in the page's front matter.

```yaml
layout: page
title: My page
hide_hero: true
```

## Dark overlay

If you would like to darken the hero so the title stands out more over a light image, you can set `hero_darken: true` in the page's front matter.

```yaml
layout: page
title: My page
hero_image: /path/to/img.jpg
hero_darken: true
```

You can overwrite the default hero background colour by setting the `$hero-darken` sass variable.
39 changes: 39 additions & 0 deletions _docs/pages/table-of-contents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: docs
title: Table of Contents
subtitle: Pages
menubar: docs_menu
sidebar: false
redirect_from:
- /page-with-contents/
---

## Introduction

The table of contents are generated automatically from the page content using [Jekyll TOC](https://github.com/allejo/jekyll-toc).

## Set Up

To add contents to your page add `toc: true` to the page's front matter. The contents will be displayed at the top of the page, above the content. You can also make the contents in the [menubar](#displaying-the-contents-in-the-menubar).

## Contents Title

To overwrite the default title for the contents, set `toc_title: My Custom Title` in the page's front matter.

```yaml
layout: page
title: Page With Contents
toc: true
toc_title: Custom Title
```
## Displaying the contents in the menubar
If you would prefer to display the contents in the menubar at the side of the page, then use `menubar_toc: true` instead of `toc: true`. This will also override the page's `menubar` setting.

```yaml
layout: page
title: Page With Contents
menubar_toc: true
toc_title: Custom Title
```
21 changes: 1 addition & 20 deletions _includes/site-aside.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,31 +75,12 @@ <h3 class="title is-3 mb-2">About this site</h3>

</style>

<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-1291242080282540"
data-ad-slot="7663977887"
data-ad-format="auto"
data-full-width-responsive="true"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</div>
{% elsif page.layout == "categories" %}
{% elsif page.layout == "categories" %}
<div class="section section--category-index">
<h3>Index</h3>
{% include nav-categories.html %}
</div>
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-1291242080282540"
data-ad-slot="7663977887"
data-ad-format="auto"
data-full-width-responsive="true"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
{% endif %}


</aside>
Loading

0 comments on commit 59aacf0

Please sign in to comment.