Skip to content
This repository has been archived by the owner on Jul 13, 2024. It is now read-only.

Latest commit

 

History

History
90 lines (60 loc) · 5.8 KB

MANUAL.md

File metadata and controls

90 lines (60 loc) · 5.8 KB
Raw

How to turn about.awalkaday.art into an online book on GitBook.com

Instructions provided by LLAMA 3 (Open-Source AI) after interaction with a human at DuckDuckGo AI Chat on July 2, 2024.

PROMPT

hey there! i will need your assistance for an ongoing project. i am looking for ways to turn a public git code repository of mine (on github) into an online book powered by gitbook. com tools. here is the repo link: https://github.com/awalkaday/about-awalkaday-art. can you advise me in steps to follow in order to turn the index.html of that code repo into a book, by leveraging the git commits format, history and integration of platform tools. thank you.

Instruction Manual

AI Advice

I'd be happy to help you with that.

To turn your GitHub repository into an online book using GitBook, you'll need to follow these steps:

Step 1: Prepare your repository

  • Make sure your repository is publicly accessible and has a clear structure. In your case, it looks like you have an index.html file, which is a good starting point.
  • Consider organizing your content into separate folders or subfolders to make it easier to navigate and convert into a book.

Step 2: Create a GitBook account and connect your repository

  • Sign up for a GitBook account if you haven't already.
  • Go to the GitBook dashboard and click on "New Book."
  • Select "Import from GitHub" and authorize GitBook to access your GitHub account.
  • Choose your repository (awalkaday/about-awalkaday-art) and select the branch you want to use (e.g., main).

Step 3: Configure your book settings

  • In the GitBook dashboard, go to your book's settings (gear icon) and configure the following:
    • Set the book title, description, and cover image.
    • Choose a theme that suits your content (e.g., a documentation theme).
    • Set the default language and timezone.

Step 4: Convert your index.html to Markdown

  • Since GitBook uses Markdown, you'll need to convert your index.html file to Markdown format.
  • You can use an online tool like HTML to Markdown or a local tool like Pandoc to convert your file.
  • Save the converted file as README.md in your repository's root directory.

Step 5: Organize your content using GitBook's format

  • Create a SUMMARY.md file in your repository's root directory to define the book's structure.
  • In this file, list the chapters and sections you want to include in your book, using Markdown headers (e.g., # Chapter 1, ## Section 1.1).
  • Update your README.md file to include a link to the SUMMARY.md file.

Step 6: Use GitBook's plugins to leverage Git commits and history

  • In your GitBook settings, go to the "Plugins" tab and enable the "Git Commits" plugin.
  • This plugin will allow you to display Git commit history and information within your book.
  • You can also explore other plugins, such as "Git Diff" or "Git Log," to further integrate your Git repository with your book.

Step 7: Publish and customize your book

  • Once you've set up your book, click the "Publish" button to make it live.
  • Customize your book's appearance and behavior using GitBook's settings and plugins.
  • Share your book with others and enjoy!

That's it! With these steps, you should be able to turn your GitHub repository into an online book using GitBook. If you have any specific questions or need further assistance, feel free to ask.

References

GitBook FAQs Docs

Public Service Announcement

To-be-continued in 10 days

  • In order to preserve the timeline depicting the evolution of about.awalkaday.art as a Git-based code repository, it will be necessary to reuse this experimental code repo awalkaday/online-book as an instruction manual (or a template).

  • The code powering the book will then be developed on a dedicated Markdown-written branch of awalkaday/about-awalkaday-art and ultimately merged into it. The live coding performance will take place during ETHGlobal Brussels on July 12-14, 2024.

  • The non-textual content of the book has yet to be selected and integrated into the final product. The end product would be an onchain book about.awalkaday.art released in celebration of such a special blockchain-themed week in Brussels.

  • This code repository serves as a public template for future coding challenges. It is the fruit of a self-assigned training task in preparation of a soon-to-be published book, powered online by GitBook and onchain by Ethereum, prior to Ethereum Community Conference [7] and ETHGlobal Brussels 2024.

  • Computer-aided activities undertaken during the Ethereum-focused hackhathon might be streamed online and/or publicly recorded.

  • As a solo artist and creative coder taking part in such a global blockchain event for the first time, I may request the assistance of a non-human collaborator, an open-sourced AI agent (Llama or Mistral), during the 72-hours coding challenge.

UPDATE (2024/07/13)

Future and announced plans for this coding project were unilaterally canceled on July 12, 2024. Due to insufficient funds to publish an onchain book and a last-minute avoidance of greedy intent. A new and better approach will be considered later as more skills are acquired during the summer hackathon.