Home
Jekyll
Integrating with JekyllAccessing recordsRetrieve fields valuesLink fieldsImage manipulationModular content fieldsLocalizationManaging SEO
    In this page
    Integrating with Jekyll

    DatoCMS offers a Ruby-based CLI tool that makes it extremely convenient to transform the content stored in your administrative area into local:

    Once content coming from DatoCMS is dumped into local files, you are free to use Jekyll just like you're used to. You are in charge of specifing how DatoCMS records will be dumped into these files using a Ruby config file called dato.config.rb.

    Disclaimer: this guide assumes you already know what Jekyll is and how it works. If you need some help getting started with Jekyll, you can read the official Jekyll documentation, as well as Awesome Jekyll and Jekyll Tips, which feature a comprehensive set of guides, videos and curated resources.

    Installation

    Inside your Jekyll project, you can install the dato gem tool running these commands:

    $ echo 'gem "dato"' >> Gemfile
    $ bundle install

    The gem exposes a CLI tool: if everything worked correctly, you should now run bundle exec dato and see the help banner:

    $ bundle exec dato
    DatoCMS commands:
      dato dump --token=TOKEN    # Dumps DatoCMS content into local files
      dato help [COMMAND]        # Describe available commands or one specific command

    The main command the dato CLI tool exposes is dump, which is the one you're going to use to fetch the records from our API and transform them into local files.

    You can invoke the command like this:

    $ bundle exec dato dump --token=READONLY_API_TOKEN

    You can find your API token in the Admin area > API tokens section:

    Passing the API token as environment variable

    Instead of specifying the API token as a parameter, you can pass it as an environment variable:

    $ export DATO_API_TOKEN=abc123
    $ bundle exec dato dump

    The CLI tool also loads environment variables from a .env file, so you can place the token there and forget about it (just make sure not to publish your .env file on Github):

    $ echo '.env' >> .gitignore
    $ echo 'DATO_API_TOKEN=abc123' >> .env
    $ bundle exec dato dump

    Published vs latest versions

    If you are working on development/staging environment, you might want to preview the latest version of records instead of the published one. In this case, you can add a --preview flag:

    $ bundle exec dato dump --preview

    The config file

    The dump command will read a file dato.config.rb (or the file passed by the --config option). This file should contain instructions to transform the content stored remotely in DatoCMS into local files.

    Let's watch a simple example to get started:

    # dato.config.rb
    content = { hello: "world" }
    create_data_file("_data/foobar.yml", :yaml, content)

    Here, create_data_file is a method made available to you that can generate YAML/TOML/JSON files. It's perfect to generate Jekyll data files.

    You can also generate Jekyll posts and collections with the create_post method:

    create_post "_posts/article.md" do
      content("Lorem **ipsum dolor sit amet**, consectetur adipiscing elit.")
    end

    If you need to place a collection of posts within a folder, you can use the directory method, so that every time the dump command is executed, previous content of the directory will be erased:

    directory "_posts" do
      10.times do |i|
        create_post "article-#{i}.md" do
          content("Lorem **ipsum dolor sit amet**, consectetur adipiscing elit.")
        end
      end
    end

    Now that you know how you can create local files, the final step is to start generating them with data coming from DatoCMS. An object called dato is available exactly for this purpose:

    # inside a "_posts" directory...
    directory "_posts" do
      # ...iterate over the "Blog post" records...
      dato.blog_posts.each do |article|
        # ...and create a markdown file for each article!
        create_post "#{article.slug}.md" do
          frontmatter(
            :yaml,
            title: article.title,
          )
          content(article.content)
        end
      end
    end

    Once your dato.config.rb is ready, just run the dato dump command: you should see your Jekyll project populated with content. Run jekyll serve and enjoy!

    Obviously, that's just a quick tour: you can learn all the details about how to access your records inside your config file in the following sections.

    Questions?
    We're always happy to help with code or other questions you might have. Search our documentation, forum, contact support, or connect with our sales team. You can chat live with other developers in our Slack channel.