-
Notifications
You must be signed in to change notification settings - Fork 6
Home
Check the FAQ for help with common problems, or our Troubleshooting page.
comic_git is a simple website written in HTML, CSS, and vanilla JavaScript that's designed to allow people with NO coding expertise to quickly and easily create a web comic of their own, host it for FREE, and maintain it with minimal work.
To use comic_git's most basic functions, you will need to be comfortable with:
- Copying and moving files around your computer
- Making new folders
- Editing text files in Notepad
You will also learn through these instructions how to use GitHub and set up GitHub Pages to host your webcomic.
The setup for creating your web comic (aside from creating the art for the comic itself) can be summarized in five steps:
- Click the "Use this template" button at the top of https://github.com/ryanvilbrandt/comic_git
- Name your repo, and enable GitHub Pages in Settings
- Update
your_content/comic_info.ini - Add folders in
your_content/comicsfor each comic page you want to upload. - Commit your changes and push to GitHub.
To get started, Getting Started will begin with showing you how to create your GitHub repository and publish it to GitHub Pages.
Editing your Website will instruct you on how to do things like change your website name, add comic pages, and upload your changes to GitHub.
Extra Features provides an overview of the features of comic_git beyond the basic functionality, like creating an RSS Feed.
Advanced Tips provides suggestions and tips for uncommon tasks like building comic_git locally.
You can navigate this wiki via the sidebar on the right to access all the instructions available.
If you have questions, comments, or difficulties with comic_git, please join our discord at https://discord.gg/zmdHGXB and we'll be happy to help you out!
You can see a sample website generated by the comic_git repository at https://ryanvilbrandt.github.io/comic_git_showcase/
comic_git is a static website that uses Github Actions to trigger a Python script whenever a new commit is pushed to the working branch. This script generates all the HTML files needed for the comic, as well as extra pages like the index page and archive, using Jinja2 template files. These files are then pushed to the master branch, where they are published on GitHub Pages. Javascript is used in some places like the infinite scroll page to add extra functionality, but the vast majority of the code to build the site is in the Python scripts and the templates.
It is designed this way to make comic_git accessible to people who aren't comfortable with installing extra programs or using the Windows command line, so running a script locally to generate static pages before upload is not an option.