Under construction, use at your own risk. This repo does not respect semver (yet) - things may break at any time.

GraphQL schema & API for creating/reading/updating/deleting pages in a static website which stores pages in a simple format on the file system, similarly to Kirby.

Define a file site.graphql containing the types of pages that your site should support, and the custom fields that should be included on each page:

type About {
  bio: String
}

type Film  {
  role: String
  pitch: String
  description: String
  youtubeUrl: String
}

(You will not be able to add any arguments to the fields.)

Contentbot will generate the following GraphQL schema:

# TODO

For every type in site.graphql, it will create a set of CRUD mutations, and a corresponding input type.

eg. using graphql-yoga:

const Contentbot = require('contentbot')
const GraphQLServer = require('graphql-yoga')

const schema = `
type About {
  bio: String
}

type Film  {
  role: String
  pitch: String
  description: String
  youtubeUrl: String
}
`

async function main() {
  const contentbot = await Contentbot('content', { schema })
  const server = new GraphQLServer({ schema: contentbot })
  server.start()
}
main()

For example, to add a new film page:

mutation {
  writeFilm(content: {url: "/film/national-youth-orchestra", title: "Meet the National Youth Orchestra of Great Britain", youtubeUrl: "https://www.youtube.com/watch?v=uv2Y4AoWA-w"}) {
    url
  }
}

You can then get the film page like this:

query {
  page(url: "/film/national-youth-orchestra") {
    url
    title
    ... on Film {
      youtubeUrl
    }
  }
}

Notice that the query uses an inline fragment, which is required to get the type-specific custom fields. You can also define multiple inline fragments, so you could reuse the same query for different page types, for example:

query AnyPage($url: String!) {
  page(url: $url) {
    __typename
    url
    title
    ... on Film {
      youtubeUrl
    }
    ... on About {
      bio
    }
  }
}

You could then check the __typename field, and render different templates for different types of pages.