https://github.com/deepset-ai/haystack-home

Website for Haystack, the open source LLM framework
https://github.com/deepset-ai/haystack-home

blog llm machine-learning nlp open-source

Last synced: 3 months ago
JSON representation

Website for Haystack, the open source LLM framework

• Host: GitHub
• URL: https://github.com/deepset-ai/haystack-home
• Owner: deepset-ai
• License: apache-2.0
• Created: 2022-07-11T18:07:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-10T07:44:11.000Z (3 months ago)
• Last Synced: 2025-04-10T08:40:24.765Z (3 months ago)
• Topics: blog, llm, machine-learning, nlp, open-source
• Language: HTML
• Homepage: https://haystack.deepset.ai
• Size: 184 MB
• Stars: 17
• Watchers: 6
• Forks: 10
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: code_of_conduct.txt

Awesome Lists containing this project

README

        
[![Nighly Build](https://github.com/deepset-ai/haystack-home/actions/workflows/nightly.yml/badge.svg)](https://github.com/deepset-ai/haystack-home/actions/workflows/nightly.yml)

# Haystack

This Haystack website is built using [Hugo](https://github.com/gohugoio/hugo), a static website generator written in Go.

## Contribute

1. Install Hugo using the [appropriate installation method](https://gohugo.io/getting-started/installing/) for your OS

2. Clone the project locally, and install dependencies by running `./build.sh`

3. Add or edit any content in the /content directory

4. Start a local Hugo server (with drafts enabled) by running `hugo server -D`

5. Visit http://localhost:1313/ in your browser to preview any changes made

### Adding new content

**Edits and Additions to Tutorials**:

The tutorials are maintained in the [`haystack-tutorials` repository](https://github.com/deepset-ai/haystack-tutorials)

1. Check out the [Contributing Guidelines](https://github.com/deepset-ai/haystack-tutorials/blob/main/Contributing.md)

2. Create a PR on the `haystack-tutorials` repository

3. When merged, your changes will reflect on the Haystack website after the next deployment

### Shortcodes

You can use Hugo shortcodes in markdown to call various built-in or custom templates.

**Embedding a Youtube or Vimeo video:**

```

{{< youtube w7Ft2ymGmfc >}}

{{< vimeo 146022717 >}}

```

**Adding a button:**

```

{{< button url="https://github.com/deepset-ai/haystack-home" text="Haystack website Github Repo" color="green">}}

# colors options: green, blue, dark-blue

```

**Adding tabbed content:**

```

{{< tabs totalTabs="2">}}

{{< tab tabName="First Tab Name" >}}

First tab content here

{{< /tab >}}

{{< tab tabName="Second Tab Name" >}}

Second tab content here

{{< /tab >}}

{{< /tabs >}}

```

### Adding an image in article content

```markdown

![alt text](image_path.png#small "Markdown *caption* with a **[bold link](/)**")

```

### Editing the theme

HTML template files are located at /themes/haystack/layouts

CSS (Sass) files are located at /themes/haystack/assets/sass

### Exclude Page from sitemap

To exclude any page from the sitemap add the following to the frontmatter of that page:

`sitemap_exclude: true`

Consider this for pages that are versioned that are effectively duplicates of an original page with minor changes, for example the "Benchmarks" page.

### Hide Page

To hide a blog post, tutorial or integration page, add `hidden: true` to the frontmatter.