Eleventy Notes

Configuration file

Eleventy Notes provides several configuration options to customize the app. All of them are optional, but a basic configuration is recommended.

Basic configuration

Create a new file app.json in the root of the project, next to your notes. Add a custom title (shown in the header) and a description (not shown but used by search engines):

{
  "title": "John's Notes",
  "description": "The personal notes of John Doe"
}

JSON Schema

If you use an editor like VS Code that supports JSON schema, add the $schema property to your configuration file. This will give you autocompletion, descriptions and validation:

{
  "$schema": ".app/app.schema.json"
  // ...
}

Supported configurations

In addition to the basic configuration, you can also:

  • Add an edit link to your notes, see Edit link
  • Customize the notes in the sidebar or add links to other websites, see Sidebar
  • Change the color scheme, see Themes

Summary

The following example shows the supported configuration options:

{
  "title": "John's Notes",
  "description": "The personal notes of John Doe",
  "theme": {
    "color": "sky"
  },
  "editThisNote": {
    "url": "https://example.com/edit/{{file}}"
  },
  "sidebar": {
    "links": [],
    "notes": [{}]
  }
}