[Discussion] README to generate a personal site using Hugo
Olshansk opened this issue · 0 comments
Olshansk commented
Goal
My goal (for a while) has been to create a personal site using Hugo, so I though smol developer
is the perfect opportunity to test this out.
Question
- Given my example below (README with instructions), is what I'm trying to do an inappropriate use case for
smol developer
? - I will keep iterating, but would appreciate any suggestions you have, from your experience, on how to try and leverage the library to achieve the outcome I'm trying in my
hugo_site_prompt.md
Prompt #1
I started of with a simple prompt
python3 main_no_modal.py --model=gpt4 --prompt "A hugo website with sections for blog posts, book reviews and movie reviews
Which gave the following output:
A hugo website with sections for blog posts, book reviews and movie reviews
// This is a sample code for generating a Hugo website with sections for blog posts, book reviews and movie reviews.
// First, we need to create the necessary directories for our Hugo website.
// We will create a directory called "my-hugo-website" and then create subdirectories for each section.
mkdir my-hugo-website
cd my-hugo-website
mkdir content
cd content
mkdir blog
mkdir book-reviews
mkdir movie-reviews
// Now that we have created the necessary directories, we can start creating content for our website.
// We will create a sample blog post, book review, and movie review in their respective directories.
cd blog
echo "+++\ntitle = \"My First Blog Post\"\ndate = \"2022-01-01\"\n+++\n\nThis is my first blog post!" > my-first-blog-post.md
cd ../book-reviews
echo "+++\ntitle = \"My Favorite Book\"\ndate = \"2022-01-01\"\n+++\n\nThis is my favorite book!" > my-favorite-book.md
cd ../movie-reviews
echo "+++\ntitle = \"My Favorite Movie\"\ndate = \"2022-01-01\"\n+++\n\nThis is my favorite movie!" > my-favorite-movie.md
// Finally, we can generate our Hugo website using the following command:
hugo
// This will generate our website in the "public" directory. We can then serve our website using a web server of our choice.
This gave me confidence in asking smol dev for generating a README with instructions
Prompt 2-6
Given the initial direction above, I prepared the following hugo_site_prompt.md
:
# Personal Website <!-- omit in toc -->
## Introduction
You are responsible for creating the scripts and supporting documentation to develop and maintain a personal website using hugo.
## Requirements
### README
A README that contains instructions with commands on how to:
1. Install all the necessary dependencies
1. Create the first version of my site
1. Update my site whenever I make any changes such as adding a new blog
### Hugo Theme
We will be using the `Coder` hugo theme found at: https://github.com/luizdepra/hugo-coder
### Sections
Their should be separate sections for my:
- Blogs
- Book reviews
- TV/Movie reviews
### Links
There should be links with icons to point to my:
- Twitter
- Github
- Substack
- Instagram
Which had a lot less success and direction:
hugo_site.md
---
title: "My Hugo Site"
date: 2022-01-01T00:00:00Z
draft: false
---
# Welcome to my Hugo site!
This is a sample site generated using Hugo.
## About
This site was created using the `hugo new site` command.
## Posts
{{ range .Pages }}
- [{{ .Title }}]({{ .Permalink }})
{{ end }}
## Contact
You can contact me at example@example.com.
I iterated on this prompt just a handful of times but don't feel like I'm heading in the right direction. I will continue trying different approaches in the future but have decided to document where I have gotten up until now.