| name | description | keywords |
|---|---|---|
Hitchhikers Code Bank |
Stores code for hitchhikers to use and collaborate on. |
Main Site, Code Examples |
Welcome to the Hitchhikers Code Bank! Use this as a resource to easily search code examples shared by your fellow Hitchhikers. Search the repository here: https://hitchhikers.yext.com/resources/code-examples/
Each resource in this repository should conform to the following style rules:
The information in the first few lines of each resource help us to power the Answers search. It's important that these are filled out so we can power the cards in the Code Bank search experience.
To add this to your file, you can copy the markdown below and adjust the values to represent your resource. Name, Date Updated, Product, and Categories are required.
---
name: Short & Descriptive Name for the Resource
description: (Optional) Context around the resource and why it may be helpful
keywords: (Optional) Keywords that will help surface the resource in search.
imageURL: (Optional) Link to the Image URL that we can feature as a thumbnail image.
dateUpdated: 4/1/2021
communityLinks: (Optional) List of links (comma-separated) to the community where this might be reference or additional context may be found.
product: The product this pertains to (ie. Answers or Pages)
categories: The categories this falls into - choose from this list: Frontend, Card Customizations, Custom Formatters, Pages Customizations, Backend, Standard Theme Layouts, Component Customizations, Pages, Query Rules, Searchable Fields. Categories will be added as we have more examples.
---We use Markdown to format the resources in this repository. For a full guide on Github-supported markdown, please see here: https://guides.github.com/features/mastering-markdown/
Include an Introduction section to explain to a user why this resource may be useful to them. The introduction can be used to describe different use cases, link to additional reading materials, and give a brief overview of the instructions.
Afterwards, include an Instructions section to walk a user through the steps to implement. This should leverage code blocks and images where helpful to give a user a clear understanding of what they should do and most importantly, why.
Want to contribute to the code bank? Please feel free to submit your ideas either in the Hitchhikers Community or via our Idea Submission Form.