Skip to content

How to customize Chīsai?

Thomasorus edited this page May 23, 2021 · 7 revisions

Now that you imported Chīsai inside your account with the Fork button, you are ready to work on it! First, let's talk about how you are going to navigate and edit the files using github.

When you arrive on your Chīsai instance you should see something like this, minus the username:

github-code

This is the code but also the content of your website! Most importantly, this whole section is clickable and you can navigate in it like you navigate in your own files in Windows, Mac or Linux. We can even create folders and files and edit them.

Let's start by customizing the name of your website.

  1. Go inside the src folder.
  2. Click on the config.py file.

On the upper right corner, you should see a PEN ICON. Clicking on it will allow you to edit the file.

edit

Now let's start customizing it!

  1. On line 3, you can see absolute_build_url with the value https://thomasorus.github.io/Chisai/. Change thomasorus by your own github nickname.
  2. On line 11, you can see name_of_site = Chīsai. Change Chīsai with the name of your website.
  3. You can also change the description of the website on line 12
  4. And your twitter username
  5. On line 17, you'll see date_format = "EU". That means you will name your files with the day-month-year format. If you prefer the year-month-day format, replace EU by ISO.
  6. On line 18, you'll see flat_build = True. If you keep it on True, the urls of the pages will not be shown inside their containing folder (example: mywebsite.com/blog-1.html). If set to False, the urls of the pages will be shown inside their folder (example: mywebsite.com/blog/blog-1.html).
  7. When you're done, scroll down and press the green Commit changes button.

And this is done! Please note that if you are not an English speaker, you can change the text from line 14 to 16.

Ok, your Chīsai has a name, but it would be better to see the website right? For this, we are going to use Github Pages. Please follow this guide.