markprompt-js

markprompt-js copied to clipboard

Markprompt is a platform for building GPT-powered prompts. It takes Markdown, Markdoc, MDX, reStructuredText, HTML and plain text files (from a GitHub repo, website or file uploads), and creates embeddings that you can use to create a prompt, for instance using the companion headless Markprompt React components or our prebuilt dialog. Markprompt also offers analytics, so you can gain insights on how visitors interact with your docs.

Components

This repo contains various UI libraries for building prompts based on the Markprompt API:

• @markprompt/core — shared utility functions to speak with the Markprompt API.
• @markprompt/react — a React component.
• @markprompt/web — a pre-built Markprompt component, based on @markprompt/react, built with Preact for bundle-size savings. Viable for use with vanilla JavaScript or any framework.
• @markprompt/docusaurus-theme-search — a Markprompt search theme for Docusaurus.

and some example implementations:

• with-css-modules — a web application based on @markprompt/react, Vite and CSS Modules.
• with-custom-trigger — a reference implementation of @markprompt/web using a custom trigger button.
• with-custom-trigger-react — a reference implementation of @markprompt/react using a custom trigger button.
• with-docusaurus — a Docusaurus project with @markprompt/docusaurus-theme-search.
• with-docusaurus-algolia — a Docusaurus project with @markprompt/docusaurus-theme-search and our Algolia integration.
• with-docusaurus-swizzled — a Docusaurus project with Markprompt and theme-search-algolia.
• with-init — a web application based on @markprompt/web using a global instance of Markprompt.
• with-markprompt-web — a web application based on @markprompt/web and Vite. based on @markprompt/react, Vite and CSS Modules.
• with-next — a web application based on @markprompt/react, @markprompt/web, and Next.js.
• with-standalone-chat — a web application based on @markprompt/web using a standalone version of the chat component.
• with-function-calling — a web application based on @markprompt/react and Next.js showcasing the use for OpenAI function calling.

Documentation

To use the Markprompt platform as is, please refer to the Markprompt documentation.

Community

• X

Authors

This library is created by the team behind Markprompt (@markprompt).

License

MIT © Markprompt