Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliancataldo/astro-content
A text based, structured content manager, for edition and consumption — AstroJS integration
https://github.com/juliancataldo/astro-content
api cms code-generation developer-experience editor-experience git-ops markdown schema-based ssr tooling typings validation vscode yaml
Last synced: about 2 hours ago
JSON representation
A text based, structured content manager, for edition and consumption — AstroJS integration
- Host: GitHub
- URL: https://github.com/juliancataldo/astro-content
- Owner: JulianCataldo
- License: isc
- Created: 2022-07-23T07:54:16.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-14T23:27:04.000Z (over 1 year ago)
- Last Synced: 2024-05-30T16:29:46.012Z (4 months ago)
- Topics: api, cms, code-generation, developer-experience, editor-experience, git-ops, markdown, schema-based, ssr, tooling, typings, validation, vscode, yaml
- Language: TypeScript
- Homepage: https://astro-content.dev
- Size: 6.74 MB
- Stars: 66
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
~
**Documentation / Live demo website**
❀✿❀
**𝚊𝚕𝚙𝚑𝚊**
👷🏻♂️ Under heavy development, use it at your own risk! 🚧
\~
Contributions are welcome
👐
---
## What is it?
Think of it as an hybrid of **Wordpress** + ACF, **Obsidian** and **Ulysses**, with a sprinkle of **tRPC** and **nuxt/content**.
## What it does?
✨ Adds a thin layer between Astro and your templates, bringing automatic **typings**, runtime validation and a handful of **DX** goodies.
🏗 Brings evolved authoring assistance, in a **full-fledged** back-office, inside your **IDE** or with **CLI**, as you prefer.
## Main goals
Being content centric, this set of tools will give you:
- **Focus** when designing 👌
- **Confidence** when authoring ✍️
- **Predictability** when integrating 🤝
- **Certainty** while delivering 💪
- **Peace** of mind when refactoring 👍
---
> **Warning**: This is an **`alpha`** product — Heavy changes are on-going — [Suggestions are welcome 👐](https://github.com/JulianCataldo/astro-content/issues)
## Method 1: Add to Astro project with _CLI_
With `yarn`, `npm` or `pnpm`, run this in your **existing** Astro project:
```sh
# If you want a fresh start ——v
# pnpm create astro && cd ./my-astro-site
pnpm astro add astro-content
pnpm content setup
```
Follow the prompts… 🐇
## Method 2: Clone _demo project_
Shallow **clone** this minimal Astro **starter**, which comes with dummy **content** for you to play with:
```sh
pnpx degit JulianCataldo/astro-content/demo ./ac-demo
cd ./ac-demo && pnpm install
# Clone dummy content
pnpx degit JulianCataldo/astro-content/docs/content/@dummy ./content
# —OR— setup a minimal content base with Astro Content CLI
pnpm content setup
# Open project in VS Code
code .
```
> **Warning**: Only **Node 17** or higher is actually supported by Astro Content.
## _Launch_ project
OK, **project is ready**. It's time to:
```sh
pnpm run dev
```
Now head over to [http://localhost:3000/**\_\_content**](http://localhost:9054/__content) to take a deep dive in Astro Content.
## _TypeScript_ setup
It's OK to use an absolute path, so you don't have to do tedious relative imports:
```tsx
import { get } from '../../content';
// Versus:
import { get } from '/content';
```
Astro / Vite resolve absolute paths from project root.
That's cool,
but TypeScript language server (in your IDE) will likely break, while showing
red squiggles 🤨.
A very simple fix is adding this to your `tsconfig.json` > `compilerOptions.paths`:
```jsonc
{
"compilerOptions": {
// …
"paths": {
// Make TS happy with absolute path
"/content": ["./content"]
}
}
}
```
# Development
## Setup
> **Note**: `pnpm` is the package manager of choice for developing this mono-repo.
> macOS / Node >= 17 is the most tested environment.
> Please note that end-user can use anything recommended for a typical Astro project while using Astro Content distributables.
```sh
git clone [email protected]:JulianCataldo/astro-content.git
cd astro-content
pnpm -r i
# ———— Watch / build mono-repo. (turbo)
pnpm run dev
# ———— Doc. website (astro)
cd docs && pnpm run dev
```
## Packages
| Role | Notes | Name | Artefact |
| --------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------- |
| [**Integration** ](https://github.com/JulianCataldo/astro-content/tree/master/packages/integration) _(Entrypoint)_ | Extends Astro / Vite capabilities | `astro-content` | [](https://www.npmjs.com/package/@astro-content/gui) |
| [**Server**](https://github.com/JulianCataldo/astro-content/tree/master/packages/server) | Data handlers, API provider, helpers generator | `@astro-content/server` | [](https://www.npmjs.com/package/@astro-content/gui) |
| [**Command line**](https://github.com/JulianCataldo/astro-content/tree/master/packages/cli) | Project setups and content manipulation | `@astro-content/cli` | [](https://www.npmjs.com/package/@astro-content/gui) |
| [**Web app**](https://github.com/JulianCataldo/astro-content/tree/master/packages/gui) _(Optional)_ | Full-fledge content editor / monitor | `@astro-content/gui` | [](https://www.npmjs.com/package/@astro-content/gui) |
| [TypeScript **typings**](https://github.com/JulianCataldo/astro-content/tree/master/packages/types) | Internal types for development use | `@astro-content/types` | [](https://www.npmjs.com/package/@astro-content/gui) |
| [**Docs**](https://github.com/JulianCataldo/astro-content/tree/master/docs) _(Private)_ | Using and demonstrating all tools above | | [`astro-content.netlify.app`](https://astro-content.netlify.app/) |
| [**Demo**](https://github.com/JulianCataldo/astro-content/tree/master/demo) _(Clonable)_ | Minimal boilerplate | | [./demo](https://github.com/JulianCataldo/astro-content/tree/master/demo) |
`@astro-content/*` are all internal dependencies of the main `astro-content` integration package, which act as a bridge for them.
Web GUI can be opted out by user settings.
## Deployment environments
| Branch | Description | Deployment URL |
| ------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| Feature (``) | Preview experiments or future additions in isolation. | `[branch]--astro-content.netlify.app/__content` |
| Production (`master`) | Stable release. | [`astro-content.netlify.app/__content`](https://astro-content.netlify.app/__content/) |
| 🆕 Next! (`develop`) | All future features. | [`develop--astro-content.netlify.app/__content`](https://develop--astro-content.netlify.app/__content/) |
---
🔗 [JulianCataldo.com](https://www.juliancataldo.com/)