Skip to content

ancaemcken/alinea

 
 

Repository files navigation

npm install size

Alinea CMS logo

Alinea is a modern content management system.

  • Content is stored in flat files and committed to your repository
  • Content is easily queryable through an in-memory SQLite database
  • Content is fully typed

Get started

Install alinea in your project directory

npm install alinea

Initialize alinea's config file

npx alinea init --next

Open the dashboard to have a look around

npx alinea dev

Start configuring types and fields →

Configure

Configure alinea in cms.tsx

const BlogPost = alinea.type('Blog post', {
  title: alinea.text('Blog entry title'),
  body: alinea.richText('Body text')
})

Type options and fields →

Query

Retrieve content fully-typed and filter, order, limit and join as needed.
Select only the fields you need.

import {cms} from '@/cms'

console.log(
  await cms.find(
    BlogPost()
      .where(BlogPost.author.is('Me'))
      .select({title: BlogPost.title})
  )
)

See the full api →

Content is available during static site generation and when server side querying.
Content is bundled with your code and can be queried with zero network overhead.

How alinea bundles content →

Deploy anywhere

Alinea supports custom backends that can be hosted as a simple Node.js process or on serverless runtimes.

Setup your backend →

How to contribute to this project

Have a question or an idea? Found a bug? Read how to contribute.

About

Content management for the modern web

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.9%
  • SCSS 7.5%
  • JavaScript 1.4%
  • CSS 0.2%