https://github.com/simonswiss/epic-stack-with-keystatic
An example of the Epic Stack with Keystatic
https://github.com/simonswiss/epic-stack-with-keystatic
epic-stack epic-stack-example
Last synced: 5 days ago
JSON representation
An example of the Epic Stack with Keystatic
- Host: GitHub
- URL: https://github.com/simonswiss/epic-stack-with-keystatic
- Owner: simonswiss
- License: mit
- Created: 2024-03-04T23:07:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T03:06:05.000Z (almost 2 years ago)
- Last Synced: 2025-04-01T08:36:35.271Z (11 months ago)
- Topics: epic-stack, epic-stack-example
- Language: TypeScript
- Homepage:
- Size: 12.4 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: docs/security.md
Awesome Lists containing this project
README
# Epic Stack with Keystatic
This example adds a simple blog to the Epic Stack with
[Keystatic](https://keystatic.com) and [MDX](https://mdxjs.com).
The blog is available at the `/blog` route. Posts can be edited via the MDX
files directly, or via the Keystatic Admin UI available at the `/keystatic`
route.
## Main steps taken to add Keystatic
1. Install the `@keystatic/core` and `@keystatic/remix` packages from npm
2. Define Content schemas and storage strategy a `keystatic.config.tsx` file.
This example uses the `local` storage mode (local file system). You can use
[`github`](https://keystatic.com/docs/github-mode) or
[`cloud`](https://keystatic.com/docs/cloud) modes to enable content
management from the deployed site.
3. Create `app/routes/keystatic+/$.tsx` and `app/routes/api+/keystatic.$.tsx`
routes to enable Keystatic to truly become part of your project.
4. Visit the `/keystatic` route to access the Keystatic Admin UI.
## Learn more about Keystatic
Keystatic makes Markdown, Markdoc, MDX, JSON and YAML content in your codebase
editable via an elegant Admin UI. No database — the content lives in your file
system and GitHub repository.
This example is setup to store content in MDX files, but you can also use
Markdoc, JSON or YAML to store content and make it editable.
Visit the [Keystatic website](https://keystatic.com) to learn more!