Topaz

Overview:

Topaz is a tool designed for lazy individuals who want to automate the process of updating their personal website. With features like fetching public repos from Github, the ability to write and publish blogs, and customization options, Topaz aims to simplify the website maintenance process.

Features:

• Automatically fetch public repos from Github
• Admin page for adding blogs and publication details
• Customize website by editing theme.json file
• Mobile-friendly design (currently in progress)
• Write and modify content using markdown
• Revamped home, project, and blog pages
• Ability to publish and write blogs using markdown (work in progress)

Installation:

1. Clone the project repository.
2. Edit the data/theme.json file to customize the website.
3. Generate a Github token by visiting the specified link and copying the token.
4. Create a keys.txt file in the project root directory and paste the token.
5. Install Docker if not already installed.
6. Modify the Dockerfile under the project root.
7. Build the Docker image.
8. Run the Docker image.
9. Access the website through localhost: on a web browser.
10. Login using the set username and password.
11. Optionally, modify the docker-compose.yml file to install Topaz.

Summary:

Topaz is a convenient tool for automating website updates and blog publishing, suitable for individuals looking to streamline their personal website maintenance process. By offering features like Github integration, markdown support, and customization options, Topaz simplifies the task of managing and updating online content. Installation is straightforward, requiring cloning the project, setting up Docker, and customizing the theme as needed. As the tool continues to evolve with new features like markdown blog writing, Topaz presents itself as a promising solution for effortless website management.