Tokyo Jekyll Theme docs: setup, configuration, and tips for a fast, modern Jekyll-powered website.
0 of
0 posts loaded
Tokyo Jekyll Theme Documentation
Complete documentation guide
Documentation Menu
Jekyll Theme Deployment
Deploying your Jekyll site is the final step to make it live on the internet. There are several excellent options available, each with their own advantages. This guide covers the most popular deployment methods.
Prerequisites
Before deploying, ensure your Jekyll site is ready:
Test locally first:
bundle exec jekyll serve
Build the site:
bundle exec jekyll build
Check the _site folder - this contains your built site ready for deployment.
Deployment Methods
1. GitHub Pages (Recommended for Beginners)
GitHub Pages is perfect for beginners and offers free hosting for Jekyll sites.
Documentation Generated by: ThemeixDate: August 28, 2025
How to Add Authors to Your Theme
Adding authors to your Tokyo Jekyll theme is a straightforward process that involves just two steps. Here’s how to do it:
Step 1: Assign an Author ID to Your Post
In the front matter of your blog post, you’ll need to include the author_id field. This ID links your post to a specific author.
author_id: 3
For example, your post’s front matter might look like this:
---
layout: post
title: "Test Post Title"
date: 2019-08-01 10:59:37 +0600
post_image: /assets/images/blog-images/blog-img16.jpg
tags: [tag1, tag2, tag3]
categories: [category-name]
author_id: 3
comments: false
excerpt: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
---
Here, the author_id is set to 3. You can use any unique number (e.g., 3, 4, 5) to identify different authors.
Step 2: Create an Author Entry in the _authors Data Folder
After assigning an author_id to your post, you must create a corresponding HTML file for that author within your _authors data folder. This file contains the author’s details.
Here’s an example of the configuration for an author file:
---
layout: author
name: John Doe
author_id: 3
email: example@yourdomain.com
bio: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt.
image: /assets/images/authors/author-pic.jpg
location: Sao Paulo, BR
---
You can also include optional fields like facebook, twitter, instagram, or reddit with their respective social links. These will be displayed in the author information area.
Once created, copy this HTML file into your _authors data folder. If you’ve already created an HTML file for a particular author, you can skip this step.
Setup Navigation Menu
Navigation
The navigation menu appears in the top header area of your site. You can manage and edit the navigation links by modifying the _data/navigation.yml file.
You can add a title and a url for each navigation item. To add a new link, such as an “About” page, simply append it to the list like this:
-title:Abouturl:/about
How to add my mailchimp account?
To integrate your Mailchimp newsletter signup form with your Jekyll site, you need to add your Mailchimp list (audience) URL to the site’s configuration.
What is the Mailchimp List URL?
The Mailchimp list URL (sometimes called the form action URL) is a unique link provided by Mailchimp for each audience (list) you create. This URL allows your website to send subscription requests directly to your Mailchimp account.
How to Find Your Mailchimp List URL
Log in to your Mailchimp account.
Go to the “Audience” section and select the audience (list) you want to use.
Click on “Signup forms” in the audience dashboard.
Choose “Embedded forms.”
In the code Mailchimp provides, look for the form tag. The action attribute contains your unique list URL. It will look something like:
https://YOUR_PREFIX.list-manage.com/subscribe/post?u=YOUR_U_ID&id=YOUR_ID
How to Add or Update the Mailchimp List URL in Jekyll
Open your site’s config.yml file in a text editor.
Find the following setting (or add it if it doesn’t exist):
Be sure to save your changes and redeploy your site after updating the configuration.
Disqus Comment Settings For Jekyll
To implement a Disqus comment system on your Jekyll site, you’ll need to configure it with your own Disqus account. Here’s a step-by-step guide to getting your Disqus comments up and running across different themes:
Locate the Disqus Comment Include File:
Navigate to the _includes/disqus_comment.html file within your Jekyll theme directory.
Modify the Disqus Shortname:
On line 15 of the disqus_comment.html file, locate the existing Disqus shortname.