Codebase

Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.

Getting Started Commands

Project Structure

Below is a short description of the key directories of the project to aid you when understanding where key files are located.

.devcontainer/ - This directory contains development container configuration files for various Integrated Development Environments (IDEs) and text editors. It helps in setting up the development environment with specific tools and configurations.
.git/ - This is a hidden directory that stores all the Git version control system related data for the project. It includes branches, commits, and other metadata.
assets/ - This directory contains static files such as images, stylesheets, and JavaScript files that are used by the website.
assets/css/ - This subdirectory contains all the CSS files used for styling the website.
content/ - This directory contains all the Markdown files that are used to generate the website's content.
content/_include/ - This subdirectory contains files that are included in multiple Markdown files using the {% include %} syntax.
content/helix/ - This subdirectory contains Markdown files related to the Helix project. It includes API reference, development, examples, getting-started, help, private-deployment, and using-helix sections.
content/searchbot/ - This subdirectory contains Markdown files related to the Searchbot project. It includes concepts and quick-start sections.
i18n/ - This directory contains internationalization files for translating the website's content into different languages.
layouts/ - This directory contains HTML templates used to generate the website's pages.
layouts/_default/ - This subdirectory contains the default layout used for generating the website's pages. It includes _markup and partials subdirectories.
layouts/_default/_markup/ - This subdirectory contains HTML markup used in the default layout.
layouts/partials/ - This subdirectory contains reusable HTML templates used in multiple pages.
layouts/partials/components/ - This subdirectory contains HTML templates for specific components used in the website.
layouts/partials/custom/ - This subdirectory contains custom HTML templates that can be used to override the default layout.
layouts/shortcodes/ - This subdirectory contains custom shortcodes used to generate dynamic content in Markdown files.
layouts/shortcodes/index.md - This file contains the documentation for all the available shortcodes.
scripts/ - This directory contains JavaScript files used to add functionality to the website.
static/ - This directory contains static files that are served directly by the website without any processing.
static/images/ - This subdirectory contains images used in the website.