AI Design Future

How To Use Blog

Blog Backend for JuiCy Water Studio

A quick setup guide to help you upload your first blog!

Installation

  1. Clone the repository.
  2. Install the dependencies.
  3. Start the application using python3 app.py.

Uploading a Blog

  1. First, create a new folder under the /blogs directory. You can name this folder whatever you want, but the name of the folder MUST be the same as the article id mentioned later.

  2. Create a markdown file called content.md and write your blog in this file. Refer to the Markdown Guide for syntax details. Noted that all the images in the content.md should not be added as local image file, instead, upload your image, or any other kind of files to external CDN bucket for instant delivery. CDN helper might be helpful. With this tool, you could easily add your files or images like this:

    Image Demo

  3. Your blog cover should also using a external CDN link.

  4. Create an overview.json file with the following structure:

    {
        "title": "Title of your blog",
        "description": "A brief description",
        "date": "Date in YYYY-MM-DD format, e.g., 2025-01-29",
        "author": "Author's name",
        "id": "IMPORTANT! THIS MUST BE THE SAME AS THE NAME OF THE FOLDER MENTIONED EARLIER",
        "cover": "Cover image file link, e.g. https://cdn.example.com/cover.webp"
    }
    
  5. The structure should look like this:

    blogs/
        your_blog_id/
            content.md
            overview.json
    
  6. Once finished, git push your changes. The blog will be automatically deployed and served.

Acknowledgements

This project is licensed under the MIT License.