https://github.com/yext/pages

https://github.com/yext/pages

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/yext/pages
• Owner: yext
• License: other
• Created: 2022-04-18T17:58:09.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-03T16:39:25.000Z (over 1 year ago)
• Last Synced: 2024-12-03T17:46:58.271Z (over 1 year ago)
• Language: TypeScript
• Size: 10.8 MB
• Stars: 12
• Watchers: 6
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
![Yext](./yext.svg)

# PagesJS

PagesJS is a collection of tools that make it easy to develop on [Yext Pages](https://www.yext.com/platform/pages). It provides 2 main tools:

1. A default development server, backed by [Vite](https://vitejs.dev/), that makes local development fast and easy.

2. A Vite plugin used to bundle your assets and templates for Yext Pages.

## Packages

| Package                           | Version (click for changelog)                                                                            | Release                                          |

| --------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |

| [PagesJS](packages/pages)         | [![pages version](https://img.shields.io/npm/v/@yext/pages.svg?color=blue)](packages/pages/CHANGELOG.md) | [NPM](https://www.npmjs.com/package/@yext/pages) |

| [Pages Plugins](packages/plugins) | [![plugins version](https://shield.deno.dev/x/yextpages/@plugins)](packages/plugins/CHANGELOG.md)        | [Deno](https://deno.land/x/yextpages)            |

## Utility Functions

| Function                                                                                                 |

| -------------------------------------------------------------------------------------------------------- |

| [fetch()](https://github.com/yext/pages/blob/main/packages/pages/src/util/README.md#fetch)               |

| [getRuntime()](https://github.com/yext/pages/blob/main/packages/pages/src/util/README.md#getRuntime)     |

| [isProduction()](https://github.com/yext/pages/blob/main/packages/pages/src/util/README.md#isProduction) |

| [useDocument()](https://github.com/yext/pages/blob/main/packages/pages/src/util/README.md#useDocument)   |

## Development

See [Development Reference](https://github.com/yext/pages/blob/main/packages/pages/README.md).

## Contribution

See [Contributing Guide](https://github.com/yext/pages/blob/main/CONTRIBUTING.md).

## License

BSD 3-Clause