46 | Working with local content uses the `contentlayer/local-source` module.
47 |
48 |
49 |
50 | -
51 | -
52 | -
53 | -
54 |
55 |
56 |
--------------------------------------------------------------------------------
/content/docs/300-sources/125-notion/500-images.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: e3a04016
3 | title: Images
4 | nav_title: Images
5 | excerpt: Options on image processing when using Notion as your content source.
6 | ---
7 |
8 |
9 | ⚠ The content source plugin `contentlayer-source-notion` is currently in Alpha and should not be used in production.
10 |
11 |
12 | ---
13 |
14 | When querying images from Notion it give a temporary link that expires after a certain amount of time.
15 |
16 | Contentlayer does not currently support image processing, though we're [planning on implementing it](https://github.com/contentlayerdev/contentlayer/issues/11).
17 | Until then, there are a few different approaches you can take to working with images when your content is processed by Contentlayer:
18 |
19 | ## Using an Image Management Services
20 |
21 | Alternatively, you can use an image management service like [Cloudinary](https://cloudinary.com/) or [Imgix](https://imgix.com/). (There are many to choose from.)
22 |
23 | These services allow you to use URL parameters to determine the size and shape of your image. The image is then optimized by these services and delivered to your users.
24 |
25 | These services deliver an optimized image, but it's still up to you to ensure that image doesn't degrade the performance of your pages. Therefore, you may also want to consider manually processing the images. See below for details.
26 |
27 | ### Processing Images as Computed Fields
28 |
29 | To process images during the Contentlayer build, you can use a computed field.
30 | Say you've a property `thumbnail`.
31 |
32 | Then you'd add a _computed_ field like `image` that would do the processing and returns the path/url to the processed image.
33 |
34 | ```js
35 | defineDatabase(() => ({
36 | name: 'Post',
37 | computedFields: {
38 | thumbnail: {
39 | type: 'string',
40 | resolve: (doc) => {
41 | // do the processing, and return new value ...
42 | },
43 | },
44 | },
45 | }))
46 | ```
47 |
48 | ### Processing after the Contentlayer Build
49 |
50 | Another option is to build a utility method within your application that does the processing. In this case, Contentlayer would have already processed the image reference as a string, which you would send to the processing utility before building the props to send to the page.
51 |
52 | ### Handling Images in Markdown with Contentlayer
53 |
54 | It's worth noting that the methods above handle processing images only that were specified in the frontmatter. If you want to process images you've used within the body of a markdown or MDX file, you'll want to build (or find) a remark or rehype plugin.
55 |
--------------------------------------------------------------------------------
/content/docs/300-sources/125-notion/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: b2ce5957
3 | title: Notion Source
4 | nav_title: Notion
5 | label: Experimental
6 | collapsible: true
7 | collapsed: true
8 | excerpt: Guides for working with Contentlayer when using Notion as your content source.
9 | ---
10 |
11 |
12 | ⚠ The content source plugin `contentlayer-source-notion` is currently in Alpha and should not be used in production.
13 |
14 |
15 | This plugin allows you to use Notion as a content source. It automatically generates type by inferring your page properties and transform Rich Text into HTML.
16 |
17 |
18 |
23 | Our getting started tutorial shows you how to use Notion to manage your Next.JS Blog.
24 |
25 |
26 |
Follow the getting started tutorial to start working with Notion as a Content source.
51 | Working with Notion uses the `contentlayer/notion-source` module.
52 |
53 |
54 |
55 | -
56 | -
57 | -
58 |
59 |
60 |
--------------------------------------------------------------------------------
/content/docs/300-sources/150-remote-files.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: fbb47906
3 | title: Remote Files
4 | label: Experimental
5 | excerpt: How to use Contentlayer with remote files as content source (e.g. Git repo)
6 | ---
7 |
8 | The remote files source acts very similarly to the [files source](/docs/sources/files) with the difference that the content files can live outside the website folder. Using the remote files source Contentlayer will automatically **sync the content files from your remote files source to your local website folder** and then process them using the regular files source.
9 |
10 | Common remote file sources including other Git repositories, databases, APIs or anywhere else where your content comes from.
11 |
12 | ## Example: Remote Git Repository
13 |
14 | See [full example here](https://github.com/contentlayerdev/contentlayer/tree/main/examples/node-script-remote-content).
15 |
16 | ```ts
17 | // NOTE we're using the `defineDocumentType` from the regular files source
18 | import { defineDocumentType } from '@contentlayer/source-files'
19 | import { spawn } from 'node:child_process'
20 | import { makeSource } from '@contentlayer/source-remote-files'
21 |
22 | const Post = defineDocumentType(() => ({
23 | name: 'Post',
24 | filePathPattern: `docs/**/*.md`,
25 | fields: {
26 | title: { type: 'string', required: false },
27 | },
28 | }))
29 |
30 | const syncContentFromGit = async (contentDir: string) => {
31 | const syncRun = async () => {
32 | const gitUrl = 'https://github.com/vercel/next.js.git'
33 | // TODO: git pull or git clone (see full example for working code)
34 | }
35 |
36 | let wasCancelled = false
37 | let syncInterval
38 |
39 | const syncLoop = async () => {
40 | await syncRun()
41 |
42 | if (wasCancelled) return
43 |
44 | syncInterval = setTimeout(syncLoop, 1000 * 60)
45 | }
46 |
47 | // Block until the first sync is done
48 | await syncLoop()
49 |
50 | return () => {
51 | wasCancelled = true
52 | clearTimeout(syncInterval)
53 | }
54 | }
55 |
56 | export default makeSource({
57 | syncFiles: syncContentFromGit,
58 | contentDirPath: 'nextjs-repo',
59 | contentDirInclude: ['docs'],
60 | documentTypes: [Post],
61 | disableImportAliasWarning: true,
62 | })
63 | ```
64 |
65 | ## Notes
66 |
67 | - It's recommended to add the synced content directory to your `.gitignore` file
68 | - It's possible to combine the regular files source and the remote files source. You'll have to use the same root `contentDirPath` and put the respective content in different sub directories.
69 |
--------------------------------------------------------------------------------
/content/docs/300-sources/200-contentful.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: d72dff47
3 | title: Contentful
4 | label: Planned
5 | excerpt: We are planning to officially support Contentful. Add your vote to help us prioritize the work.
6 | ---
7 |
8 | Support for Contentful is planned, but it is not yet stable. To help us prioritize this work, please add your vote to [this GitHub issue](https://github.com/contentlayerdev/contentlayer/issues/173).
9 |
--------------------------------------------------------------------------------
/content/docs/300-sources/300-sanity.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: c4fdd0f7
3 | title: Sanity
4 | label: Considering
5 | excerpt: We're considering officially supporting Sanity. Add your vote.
6 | ---
7 |
8 | We're currently considering support for Sanity. Please add your vote to [this GitHub issue](https://github.com/contentlayerdev/contentlayer/issues/172) to help us prioritize the work.
9 |
--------------------------------------------------------------------------------
/content/docs/300-sources/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: acc47cf6
3 | title: Content Sources
4 | nav_title: Sources
5 | excerpt: Solving specific scenarios using Contentlayer.
6 | show_child_cards: true
7 | ---
8 |
9 | Contentlayer lets you choose the source for your content.
10 |
11 | Currently only local file source is officially supported. Visit the others for instructions on how to add your vote.
12 |
13 | [Join our Discord community](https://discord.gg/rytFErsARm) to suggest new sources.
14 |
--------------------------------------------------------------------------------
/content/docs/400-environments/200-remix.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: b3975f99
3 | title: Remix
4 | label: Considering
5 | excerpt: We're considering officially supporting Remix. Add your vote.
6 | ---
7 |
8 | We're currently considering support for Remix. Please add your vote to [this GitHub issue](https://github.com/contentlayerdev/contentlayer/issues/169) to help us prioritize the work.
9 |
--------------------------------------------------------------------------------
/content/docs/400-environments/300-svelte.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: efe6735d
3 | title: SvelteKit
4 | label: Considering
5 | excerpt: We're considering officially supporting Svelte and SvelteKit. Add your vote.
6 | ---
7 |
8 | We're currently considering support for SvelteKit. Please add your vote to [this GitHub issue](https://github.com/contentlayerdev/contentlayer/issues/170) to help us prioritize the work.
9 |
--------------------------------------------------------------------------------
/content/docs/400-environments/400-astro.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: d57135c9
3 | title: Astro
4 | label: Considering
5 | excerpt: We're considering officially supporting Astro. Add your vote.
6 | ---
7 |
8 | We're currently considering support for Astro. Please add your vote to [this GitHub issue](https://github.com/contentlayerdev/contentlayer/issues/171) to help us prioritize the work.
9 |
--------------------------------------------------------------------------------
/content/docs/400-environments/500-vite.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: ba80b355
3 | title: Vite
4 | label: Considering
5 | excerpt: We're considering officially supporting Vite. Add your vote.
6 | ---
7 |
8 | We're currently considering support for Vite. Please add your vote to [this GitHub issue](https://github.com/contentlayerdev/contentlayer/issues/179) to help us prioritize the work.
9 |
--------------------------------------------------------------------------------
/content/docs/400-environments/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: c6df80ab
3 | title: Environments
4 | excerpt: Solving specific scenarios using Contentlayer.
5 | show_child_cards: true
6 | ---
7 |
8 | Contentlayer supports a tight integration with Next.js.
9 |
10 | Other environment support is coming soon. Visit those we're considering below for instructions on how to add your vote.
11 |
12 | [Join our Discord community](https://discord.gg/rytFErsARm) to suggest new environments.
13 |
--------------------------------------------------------------------------------
/content/docs/500-reference/100-cli.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: e9e2f788
3 | title: Contentlayer CLI
4 | nav_title: CLI
5 | excerpt: Working with Contentlayer on the command line.
6 | ---
7 |
8 | The Contentlayer CLI enables you to transform your content into data.
9 |
10 | ## Usage
11 |
12 | ```txt
13 | contentlayer [options]
14 | ```
15 |
16 | To get a list of all commands, you can run `contentlayer` with the `--help` flag:
17 |
18 | ```txt
19 | contentlayer --help
20 | ```
21 |
22 | Which will produce an output that looks like this:
23 |
24 | ```txt
25 | ━━━ Contentlayer CLI - 0.0.34 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
26 |
27 | $ contentlayer
28 |
29 | ━━━ General commands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
30 |
31 | contentlayer build [-c,--config #0] [--clearCache] [--verbose]
32 | Transforms your content into static data
33 |
34 | contentlayer dev [-c,--config #0] [--clearCache] [--verbose]
35 | Same as "contentlayer build" but with watch mode
36 |
37 | You can also print more details about any of these commands by calling them
38 | with the `-h,--help` flag right after the command name.
39 | ```
40 |
41 | ## Commands
42 |
43 | ### `build`
44 |
45 | ```txt
46 | contentlayer build [options]
47 | ```
48 |
49 | Transforms content into data objects that your pages and components can consume. These objects are written to files in the `.contentlayer/generated` directory.
50 |
51 | ### `dev`
52 |
53 | ```txt
54 | contentlayer dev [options]
55 | ```
56 |
57 | Runs a build, then listens for changes to your content files, rebuilding after each change.
58 |
59 | ## Options
60 |
61 | The following options are available to run with each command.
62 |
63 | ### `config` (alias: `-c`)
64 |
65 | Use a custom config file path. Both `contentlayer.config.ts` and `contentlayer.config.js` work by default.
66 |
67 | ### `clearCache`
68 |
69 | Clears the `.contentlayer/generated` directory before running the specified command.
70 |
71 | ### `verbose`
72 |
73 | Adds more detailed output when running a command.
74 |
75 | ### `help`
76 |
77 | Generates usage instructions and options for the CLI. Does not require an associated command.
78 |
--------------------------------------------------------------------------------
/content/docs/500-reference/200-next-contentlayer.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: e6e7eb3a
3 | title: next-contentlayer
4 | excerpt: Helper for improving the experience when developing with Next.js.
5 | ---
6 |
7 | The Next.js plugin provides helpers for improving the developer experience in using Contentlayer with Next.js.
8 |
9 | ## `withContentlayer`
10 |
11 | The `withContentlayer` utility automatically hooks Contentlayer into Next.js `build` and `dev` processes, which means you don't have to worry about working with the CLI when running or building your Next.js project.
12 |
13 | To enable it, add the following to your `next.config.js` file:
14 |
15 | ```js
16 | // next.config.js
17 |
18 | import { withContentlayer } from 'next-contentlayer'
19 |
20 | export default withContentlayer({})
21 | ```
22 |
23 | ## `useMDXComponent`
24 |
25 | If you're using MDX in your Next.js project, `useMDXComponent` makes it easy to render MDX in your layouts.
26 |
27 | Here is an example of a layout that receives a `slug `parameter, then uses it to retrieve a document and render MDX on the page.
28 |
29 | ```jsx
30 | import { useMDXComponent } from 'next-contentlayer/hooks'
31 | import { allDocs } from 'contentlayer/generated'
32 | import Button from '../components/Button'
33 |
34 | const mdxComponents = {
35 | Button,
36 | }
37 |
38 | export default function DocPage({ doc }) {
39 | const MDXContent = useMDXComponent(doc.body.code)
40 |
41 | return (
42 |
43 |
{doc.title}
44 |
45 |
46 | )
47 | }
48 |
49 | export const getStaticProps = ({ params: { slug } }) => {
50 | const doc = allDocs.find((doc) => doc._raw.flattenedPath === slug)
51 | return { props: { doc } }
52 | }
53 | ```
54 |
55 |
56 | Remember to set `contentType: 'mdx'` in your config for proper [processing of MDX files](/docs/sources/files/mdx).
57 |
58 |
59 | For a more holistic view of using MDX in a project, refer to [the example Next.js project](https://github.com/contentlayerdev/next-contentlayer-example).
60 |
61 | ## `createContentlayerPlugin`
62 |
63 | The `createContentlayerPlugin` function allows you to add non-default configuration options to the next-contentlayer plugin. This is not a common use. See [`withContentlayer`](#withContentlayer) for typical use.
64 |
65 | ```js
66 | import { createContentlayerPlugin } from 'next-contentlayer'
67 |
68 | const withContentlayer = createContentlayerPlugin({
69 | // Additional Contentlayer config options
70 | })
71 |
72 | export default withContentlayer({
73 | // Your Next.js config...
74 | })
75 | ```
76 |
--------------------------------------------------------------------------------
/content/docs/500-reference/200-source-files/300-define-nested-type.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: eeeb4ab5
3 | title: defineNestedType
4 | excerpt: Technical reference for defining a nested document type schema.
5 | ---
6 |
7 | `defineNestedType` defines the schema for a reusable shape of data that can be embedded within documents.
8 |
9 | Nested types are defined within document type definitions, and therefore do not have to be included in the [`makeSource` options](/docs/reference/source-files/make-source).
10 |
11 | ## Usage
12 |
13 | ```js
14 | const SEO = defineNestedType(() => ({
15 | name: 'SEO',
16 | fields: {
17 | title: {
18 | type: 'string',
19 | },
20 | },
21 | }))
22 |
23 | const Doc = defineDocumentType(() => ({
24 | name: 'Doc',
25 | filePathPattern: '**/*.md',
26 | fields: {
27 | // ...
28 | seo: {
29 | type: 'nested',
30 | of: SEO,
31 | },
32 | },
33 | }))
34 | ```
35 |
36 | ## Options
37 |
38 | ### `name` (required)
39 |
40 | Name of the document. This defines the types and functions that are generated for documents of this type.
41 |
42 | ```js
43 | const SEO = defineNestedType(() => ({
44 | name: "SEO",
45 | // ...
46 | })
47 | ```
48 |
49 | Because nested types are not documents, they are not exported as individual data files. But a type definition will still be generated (as `SEO` in the usage example).
50 |
51 | ### `fields`
52 |
53 | Field definitions determine the data shape for the document type. See [the field types reference](/docs/reference/source-files/field-types) for more information.
54 |
55 | ### `description`
56 |
57 | Provides a description for the generated type definition.
58 |
--------------------------------------------------------------------------------
/content/docs/500-reference/200-source-files/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: f4638f76
3 | title: '@contentlayer/source-files'
4 | excerpt: API reference for working with local files (Git CMS).
5 | collapsible: true
6 | collapsed: true
7 | ---
8 |
9 | This module provides the methods for working with local files as your content source.
10 |
11 | Typical usage involves three primary functions:
12 |
13 | - [`makeSource`](/docs/reference/source-files/make-source) controls the entire schema definition for your application.
14 | - [`defineDocumentType`](/docs/reference/source-files/define-document-type) defines the schema top-level document types (also known as _models_ or _content types_).
15 | - [`defineNestedType`](/docs/reference/source-files/define-nested-type) defines the schema for data shapes that can be reused across multiple document type definitions.
16 |
17 | ---
18 |
19 | ## Reference Guides
20 |
21 |
22 |
23 | These guides will dig into the details of each function to enable you to better understand how to work with local
24 | content.
25 |
38 | There are a few other guides to help you learn how to work with Notion.
39 |
40 |
41 |
42 | -
43 | -
44 | -
45 | -
46 | -
47 |
48 |
49 |
--------------------------------------------------------------------------------
/content/docs/500-reference/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: abcab6a5
3 | title: API Reference
4 | show_child_cards: true
5 | excerpt: Technical API reference for Contentlayer usage.
6 | ---
7 |
8 | Technical API reference for Contentlayer, the CLI, and associated plugins.
9 |
--------------------------------------------------------------------------------
/content/docs/600-integrations/100-stackbit/300-dev-server.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: f1dfe99b
3 | title: Stackbit Development Server
4 | nav_title: Development Server
5 | excerpt: Hook the Stackbit development server into Next.js and Contentlayer.
6 | ---
7 |
8 | The Stackbit development server is run using [the `stackbit dev` command](https://docs.stackbit.com/reference/stackbit-cli#dev).
9 |
10 | [`experimental-next-stackbit`](https://npmjs.com/package/experimental-next-stackbit) can be used in conjunction with [`next-contentlayer`](/docs/reference/next-contentlayer) to hook the [`contentlayer dev`](/docs/reference/cli#dev) and [`stackbit dev`](https://docs.stackbit.com/reference/stackbit-cli#dev) commands into the Next.js development server (`next dev`). See below for usage.
11 |
12 | ## `withStackbit`
13 |
14 | Next.js configuration, along with the [`withContentlayer` hook](/docs/reference/next-contentlayer#withcontentlayer) should be wrapped in the `withStackbit` method.
15 |
16 | ```js
17 | // next.config.js
18 |
19 | const { withContentlayer } = require('next-contentlayer')
20 | const { withStackbit } = require('experimental-next-stackbit')
21 |
22 | module.exports = withStackbit(
23 | withContentlayer({
24 | reactStrictMode: true,
25 | }),
26 | )
27 | ```
28 |
29 | This function will automatically detect if you are in production (when `process.env.NODE_ENV` is `production`) and skip running the Stackbit development server.
30 |
--------------------------------------------------------------------------------
/content/docs/600-integrations/100-stackbit/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: b1141d65
3 | title: Stackbit
4 | excerpt: Stackbit is a composable visual editor that supports multiple content sources and site frameworks.
5 | label: Experimental
6 | collapsible: true
7 | collapsed: true
8 | show_child_cards: true
9 | ---
10 |
11 | Stackbit is a composable visual editor that supports multiple content sources and site frameworks.
12 |
13 | 
14 |
15 | Contentlayer can be used in sites that are Stackbit-enabled to ease the process for developers working with content in their components and pages.
16 |
17 | Contentlayer provides a method for [transforming Stackbit configuration into Contentlayer configuration](/docs/integrations/stackbit/config), so you only have to define the shape of your content in one place.
18 |
19 | ## How it Works
20 |
21 | With the appropriate packages installed, the process works like this:
22 |
23 | 1. Define the shape of your documents using [Stackbit's `models` property](https://docs.stackbit.com/reference/config/content-modeling/models).
24 | 1. Import Stackbit config object into the Contentlayer configuration file.
25 | 1. Extend any necessary properties to support your code.
26 | 1. Configure the Contentlayer source.
27 |
28 | See below for an example, and also view [the API reference](/docs/integrations/stackbit/config) for specific usage details.
29 |
30 | ## Example Project
31 |
32 | If you'd like to see this in process, check out [this example project](https://github.com/stackbit-themes/stackbit-examples/tree/main/contentlayer), which integrates Stackbit and Contentlayer in a Next.js site.
33 |
34 | The README file has setup information, but we recommend reading through the tutorial below to understand how the pieces fit together.
35 |
36 | ## Stackbit Guides
37 |
38 | The following docs will get you started integrating Stackbit and Contentlayer into your Next.js project.
39 |
--------------------------------------------------------------------------------
/content/docs/600-integrations/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: ed449e02
3 | title: Integrations
4 | excerpt: Connections to other services that are not sources or frameworks
5 | show_child_cards: true
6 | ---
7 |
8 | Contentlayer has additional integrations that are not specific to content sources or site frameworks. These guides are shown below.
9 |
--------------------------------------------------------------------------------
/content/docs/700-other/100-faq.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: e58c2f47
3 | title: Frequently Asked Questions
4 | nav_title: FAQ
5 | excerpt: Answers to the most common questions about Contentlayer.
6 | ---
7 |
8 | ## What problem is Contentlayer solving?
9 |
10 | Modern web frameworks don't prescribe a method for parsing content. They provide powerful page routing and rendering processes, but it's up to you to provide it with content.
11 |
12 | That's a lot of work. Without the time and energy to build a truly great processing mechanism, it's easy to quickly degrade the developer experience these tools have afforded us.
13 |
14 | Contentlayer persists the great developer experience provided by modern web frameworks by making it easy to work with content in your web project.
15 |
16 | ## Why is Contentlayer fast?
17 |
18 | Contentlayer leverages optimizations of build tools to the fullest to make processing source content a breeze.
19 |
20 | It then caches that content intelligently and builds incrementally. When you update content, Contentlayer will only build what has changed, taking advantage of work already done.
21 |
22 | ## Can I use Contentlayer with my existing tools?
23 |
24 | Contentlayer is built to be framework agnostic. Contentlayer is a content processor at its core, but provides modules for importing content from various sources, and uses plugins to provide tight integration with modern frameworks.
25 |
26 | Our docs list [current supported sources](/docs/sources) and [frameworks](/docs/environments). And if you don't see what you're looking for, [start a discussion](https://github.com/contentlayerdev/contentlayer/issues/new). We're constantly looking for new use cases to consider.
27 |
28 | ## Next.js already supports MDX. Why do I need Contentlayer?
29 |
30 | It is a misconception that Next.js inherently supports MDX. Next.js makes no inference whatsoever about where your content lives and how it should be processed.
31 |
32 | Libraries like [mdx-bundler](https://github.com/kentcdodds/mdx-bundler) and [next-mdx-remote](https://github.com/hashicorp/next-mdx-remote) provide tooling to help in processing MDX. In addition to processing MDX, Contentlayer also parses and validates content and provides auto-generated TypeScript type definitions. And it does so while prioritizing performance and developer experience.
33 |
34 | Learn more about [how Contentlayer compares to other content processors](/docs/concepts/comparison#content-processors).
35 |
--------------------------------------------------------------------------------
/content/docs/700-other/200-roadmap.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: ce0cb3aa
3 | title: Roadmap
4 | excerpt: Get a picture of where we're going with upcoming releases.
5 | ---
6 |
7 | [See here](https://stackbit.notion.site/Contentlayer-Roadmap-ca6d21d6a1424b11b11692d6356c1ff7) for our roadmap.
8 |
9 | This list is not exhaustive, but meant to provide visibility into our high-level priorities.
10 |
11 | ## Adding Items to Roadmap
12 |
13 | To add something to the roadmap, first check [issues on GitHub](https://github.com/contentlayerdev/contentlayer/issues) for a relevant topic. Feel free to comment to ask for an updated status.
14 |
15 | If you don't see a relevant topic, [create one](https://github.com/contentlayerdev/contentlayer/issues/new).
16 |
17 | ## Roadmap States
18 |
19 | The roadmap shows each item in one of four states:
20 |
21 | - **Considering:** We're actively talking about the topic, but have not yet prioritized it.
22 | - **Planned:** We plan to work on these items as we release those currently in progress. These items are subject to change.
23 | - **In Progress:** Work is being done against the topic.
24 | - **Released:** The feature/change has been released in a new version.
25 |
--------------------------------------------------------------------------------
/content/docs/700-other/300-changelog.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: eec1d8c0
3 | title: Changelog
4 | excerpt: Information on detailed notes for previous releases
5 | ---
6 |
7 | When we release a new version, we notify [the Discord community](https://discord.gg/rytFErsARm) and link to [detailed release notes](https://github.com/contentlayerdev/contentlayer/releases) in GitHub.
8 |
--------------------------------------------------------------------------------
/content/docs/700-other/400-contributing.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: d739035b
3 | title: Contributing
4 | excerpt: Multiple ways to get more involved with Contentlayer.
5 | ---
6 |
7 | There are multiple ways that you can get involved to help make Contentlayer the best way to work with content in your front end applications:
8 |
9 | - Using Contentlayer
10 | - Providing Support
11 | - Promoting Contentlayer
12 | - Building Examples
13 | - Writing Documentation
14 | - Contributing Code
15 |
16 | ## Using Contentlayer
17 |
18 | The easiest and most valuable way for you to contribute to Contentlayer is **to use it, provide feedback, and report bugs.**
19 |
20 | For feedback and general conversation, [join our Discord community](https://discord.gg/rytFErsARm). To report bugs, [open an issue on GitHub](https://github.com/contentlayerdev/contentlayer/issues/new).
21 |
22 | ## Providing Support
23 |
24 | As Contentlayer's usage grows, we'll need help keeping up with [issues on GitHub](https://github.com/contentlayerdev/contentlayer/issues). We welcome community members helping to confirm bug reports, while also adding their use cases and perspectives to feature requests.
25 |
26 | ## Promoting Contentlayer
27 |
28 | If you love Contentlayer, tell the world! Tweet about it. Write a blog post. Bring it up in a planning meeting for your next web project. Whatever it is, the more you talk about Contentlayer, the better Contentlayer becomes.
29 |
30 | ## Building Examples
31 |
32 | We have a small and focused set of examples right now. We aim to expand on these, but want to do so thoughtfully. Too many examples can be distracting for users and difficult to maintain for builders.
33 |
34 | If you'd like to build a new example or think you have a helpful one, get in touch. Send a message in #contributing on Discord, or message `seancdavis29#9241` directly, and we'll find the right example for you.
35 |
36 | ## Writing Documentation
37 |
38 | The docs are off to a good start but have a long way to go. If you are interested in writing documentation, please DM `seancdavis29#9241` on Discord.
39 |
40 | ## Contributing Code
41 |
42 | If you're interested in contributing code, please either [open an issue](https://github.com/contentlayerdev/contentlayer/issues/new) or find an issue on which you'd like to work. Add a comment stating that you'd like to work on resolving the issue, and we'll make a plan together, as the codebase is complex.
43 |
--------------------------------------------------------------------------------
/content/docs/700-other/500-known-problems.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: cdffa1e4
3 | title: Known Problems
4 | excerpt: Open bugs and other known issues.
5 | ---
6 |
7 | We track all known problems with [GitHub issues](https://github.com/contentlayerdev/contentlayer/issues).
8 |
9 | Those that have confirmed as problems are identified with the `bug` label. Here is [the list of open bugs](https://github.com/contentlayerdev/contentlayer/issues?q=is%3Aissue+is%3Aopen+label%3Abug).
10 |
11 | ## Common Problems
12 |
13 | Among the issues referenced above, these are the problems most commonly encountered by Contentlayer users, along with links to the appropriate GitHub discussion(s)/issue(s):
14 |
15 | - ESLint error: `Unable to resolve path to module 'next-contentlayer'` ([GitHub Issue](https://github.com/contentlayerdev/contentlayer/issues/48#issuecomment-1097753073))
16 | - `useLivereload` hook is needed in some cases ([GitHub Issue](https://github.com/contentlayerdev/contentlayer/issues/135))
17 |
--------------------------------------------------------------------------------
/content/docs/700-other/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: b3a6b480
3 | title: Other
4 | show_child_cards: true
5 | excerpt: A collection of other resources to help you learn more, stay up to date, and contribute.
6 | ---
7 |
8 | See below for a collection of resources to help you learn more, stay up to date, and contribute to Contentlayer.
9 |
--------------------------------------------------------------------------------
/content/docs/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | global_id: '' # Index page doesn't use a global ID
3 | title: Contentlayer Documentation
4 | nav_title: Documentation
5 | excerpt: Contentlayer is a content preprocessor that validates and transforms your content into type-safe JSON you can easily import into your application.
6 | ---
7 |
8 | Contentlayer is a content preprocessor that validates and transforms your content into type-safe JSON you can easily import into your application.
9 |
10 |
11 |
17 |
23 |
24 |
25 | ---
26 |
27 | ## Sources
28 |
29 |
30 |
31 | Contentlayer lets you choose the source for your content. Currently only local file source is officially supported.
32 |
33 |
34 |
35 | Sources that are supported, planned, or being considered:
36 |
37 | -
38 | -
39 | -
40 | -
41 |
42 |
43 |
44 |
45 | ---
46 |
47 | ## Environments
48 |
49 |
50 |
51 | Contentlayer supports a tight integration with Next.js. Other environment support is coming soon.
52 |
53 |
54 |
55 |
56 | Frameworks that are supported, planned, or being considered:
57 |
58 | -
59 | -
60 | -
61 | -
62 |
63 |
64 |
65 |
66 | ---
67 |
68 | ## Reference
69 |
70 |
71 |
72 | Technical API reference for Contentlayer, the CLI, and associated plugins.
73 |
74 |
75 |