Skip to content

Commit

Permalink
Merge pull request #18 from SaurabhChandra1024/main
Browse files Browse the repository at this point in the history
PR-08-06-24
  • Loading branch information
monk1337 authored Jun 12, 2024
2 parents e8a1f33 + 349e906 commit 2d00329
Show file tree
Hide file tree
Showing 35 changed files with 142 additions and 412 deletions.
2 changes: 1 addition & 1 deletion _site/404.html

Large diffs are not rendered by default.

257 changes: 97 additions & 160 deletions _site/assets/js/search-data.json

Large diffs are not rendered by default.

43 changes: 1 addition & 42 deletions _site/docs/Contact/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/configuration/index.html

Large diffs are not rendered by default.

4 changes: 1 addition & 3 deletions _site/docs/customization/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/index-test/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/layout/26-nov-2023-meetup/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/layout/layout/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/layout/minimal/default-child/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/buttons/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/callouts/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/code/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/code/line-numbers/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/labels/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/lists/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/tables/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/ui-components/typography/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/utilities.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/utilities/color/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/utilities/layout/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/utilities/responsive-modifiers/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/docs/utilities/typography/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/projects/lallan/index.html

Large diffs are not rendered by default.

164 changes: 2 additions & 162 deletions docs/Contact.md
Original file line number Diff line number Diff line change
@@ -1,167 +1,7 @@
---
layout: default
title: Contact
title: Contact Us
nav_order: 8
---

# Search
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

---

Just the Docs uses [lunr.js](https://lunrjs.com) to add a client-side search interface powered by a JSON index that Jekyll generates.
All search results are shown in an auto-complete style interface (there is no search results page).
By default, all generated HTML pages are indexed using the following data points:

- Page title
- Page content
- Page URL

## Enable search in configuration

In your site's `_config.yml`, enable search:

```yaml
# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
```
### Search granularity
Pages are split into sections that can be searched individually.
The sections are defined by the headings on the page.
Each section is displayed in a separate search result.
```yaml
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
search.heading_level: 2
```
### Search previews
A search result can contain previews that show where the search words are found in the specific section.
```yaml
# Maximum amount of previews per search result
# Default: 3
search.previews: 3

# Maximum amount of words to display before a matched word in the preview
# Default: 5
search.preview_words_before: 5

# Maximum amount of words to display after a matched word in the preview
# Default: 10
search.preview_words_after: 10
```
### Search tokenizer
The default is for hyphens to separate tokens in search terms:
`gem-based` is equivalent to `gem based`, matching either word.
To allow search for hyphenated words:

```yaml
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
search.tokenizer_separator: /[\s/]+/
```

### Display URL in search results

```yaml
# Display the relative url in search results
# Supports true (default) or false
search.rel_url: false
```

### Display search button

The search button displays in the bottom right corner of the screen and triggers the search input when clicked.

```yaml
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
search.button: true
```

## Hiding pages from search

Sometimes you might have a page that you don't want to be indexed for the search nor to show up in search results, e.g., a 404 page.
To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter:

#### Example

{: .no_toc }

```yaml
---
layout: default
title: Page not found
nav_exclude: true
search_exclude: true
---
```

## Generate search index when used as a gem

If you use Just the Docs as a remote theme, you do not need the following steps.

If you use the theme as a gem, you must initialize the search by running this `rake` command that comes with `just-the-docs`:

```bash
$ bundle exec just-the-docs rake search:init
```

This command creates the `assets/js/zzzz-search-data.json` file that Jekyll uses to create your search index.
Alternatively, you can create the file manually with [this content]({{ site.github.repository_url }}/blob/main/assets/js/zzzz-search-data.json).

## Custom content for search index
{: .d-inline-block }

New (v0.4.0)
{: .label .label-green }

Advanced
{: .label .label-yellow }

By default, the search feature indexes a page's `.content`, `.title`, and *some* headers within the `.content`. Other data (e.g. front matter, files in `_data` and `assets`) is not indexed. Users can customize what is indexed.

{: .warning }
> Customizing search indices is an advanced feature that requires Javascript and Liquid knowledge.

1. When Just the Docs is a local or gem theme, ensure `assets/js/zzzz-search-data.json` is up-to-date with [Generate search index when used as a gem](#generate-search-index-when-used-as-a-gem).
2. Add a new file named `_includes/lunr/custom-data.json`. Insert custom Liquid code that reads your data (e.g. the page object at `include.page`) then generates custom Javascript fields that hold the custom data you want to index. Verify these fields in the generated `assets/js/search-data.json`.
3. Add a new file named `_includes/lunr/custom-index.js`. Insert custom Javascript code that reads your custom Javascript fields and inserts them into the search index. You may want to inspect `assets/js/just-the-docs.js` to better understand the code.

#### Example

This example adds front matter `usage` and `examples` fields to the search index.

`_includes/lunr/custom-data.json` custom code reads the page `usage` and `examples` fields, normalizes the text, and writes the text to custom Javascript `myusage` and `myexamples` fields. Javascript fields are similar yet [not the same as JSON](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON#javascript_and_json_differences). `jsonify` will probably work for most scenarios.

{% raw %}
```liquid
{%- capture newline %}
{% endcapture -%}
"myusage": {{ include.page.usage | markdownify | replace:newline,' ' | strip_html | normalize_whitespace | strip | jsonify }},
"myexamples": {{ include.page.examples | markdownify | replace:newline,' ' | strip_html | normalize_whitespace | strip | jsonify }},
```
{% endraw %}

`_includes/lunr/custom-index.js` custom code is inserted into the Javascript loop of `assets/js/just-the-docs.js`. All custom Javascript fields are accessed as fields of `docs[i]` such as `docs[i].myusage`. Finally, append your custom fields on to the already existing `docs[i].content`.

```javascript
const content_to_merge = [docs[i].content, docs[i].myusage, docs[i].myexamples];
docs[i].content = content_to_merge.join(' ');
```
# Contact Us
8 changes: 6 additions & 2 deletions docs/Volunteer Opportunities at Lucknow AI.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,11 @@ These roles require organizational skills and attention to detail, ideal for tho
## General Volunteer Application Form
{: .label .label-red }

- https://forms.gle/Q9pjpaVLpEi5CpRR9
- **Fill the form given below !**

{: .note }
Join the movement to make a difference in the community by volunteering with us. Whether you're looking to gain new skills, meet like-minded individuals, we have a variety of opportunities available. By filling out our application form, you'll be taking the first step towards becoming part of a dynamic team dedicated to Accelearte AI Awareness in Lucknow. Our volunteer program is designed to be flexible and accommodating, so whether you have a few hours a week or a few days a month, we have a role that's right for you. So why wait? Fill out our application form today and start making a difference in the lives of others!"
Join the movement to make a difference in the community by volunteering with us. Whether you're looking to gain new skills, meet like-minded individuals, we have a variety of opportunities available. By filling out our application form, you'll be taking the first step towards becoming part of a dynamic team dedicated to Accelearte AI Awareness in Lucknow. Our volunteer program is designed to be flexible and accommodating, so whether you have a few hours a week or a few days a month, we have a role that's right for you. So why wait? Fill out our application form today and start making a difference in the lives of others!"



<iframe src="https://docs.google.com/forms/d/e/1FAIpQLSfTw6CdAKihCrKLBYHs2pJoHWwjhbi5m_kRx3DciDnyvzZt_Q/viewform?embedded=true" width="640" height="2455" frameborder="0" marginheight="0" marginwidth="0">Loading…</iframe>
13 changes: 7 additions & 6 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ title: Resources
nav_order: 6
---

# Customization

{: .no_toc }

## Table of contents
# Table of contents

{: .no_toc .text-delta }

Expand All @@ -19,11 +17,14 @@ nav_order: 6
---

## 1. Awesome Low Resource Indian Languages Hub
https://github.com/LucknowAI/Awesome-Low-Resource-Indian-Languages-Hub?tab=readme-ov-file#papers
[Click Here !][def1]{: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }

---

## 2. Learning Resources
https://github.com/LucknowAI/ai_all_resources
[Click Here !][def2]{: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }

---

---
[def1]: https://github.com/LucknowAI/Awesome-Low-Resource-Indian-Languages-Hub?tab=readme-ov-file#papers
[def2]: https://github.com/LucknowAI/ai_all_resources
7 changes: 1 addition & 6 deletions docs/ui-components/ui-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,4 @@ title: Research & Publications
nav_order: 3
has_children: true
permalink: /docs/ui-components
---

# UI Components

To make it as easy as possible to write documentation in plain Markdown, most UI components are styled using default Markdown elements with few additional CSS classes needed.
{: .fs-6 .fw-300 }
---
4 changes: 0 additions & 4 deletions docs/utilities/utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,4 @@ has_children: true
permalink: docs/utilities
---

# Utilities
{: .no_toc }

CSS utility classes come in handy when you want to override default styles to create additional whitespace (margins/padding), correct unexpected shifts in font size or weight, add color, or hide (or show) something at a specific screen size.
{: .fs-6 .fw-300 }

0 comments on commit 2d00329

Please sign in to comment.