diff --git a/README.md b/README.md index 627f9a2..3a5c7e5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,52 @@ A Flask-based webcomic website with server-side rendering using Jinja2 templates. +## Table of Contents + +- [What is This?](#what-is-this) +- [How Does This Compare to Rarebit?](#how-does-this-compare-to-rarebit) +- [Simple Hosting Options](#simple-hosting-options) + - [PythonAnywhere (Recommended for Beginners)](#pythonanywhere-recommended-for-beginners) + - [Render](#render) + - [Railway](#railway) + - [DigitalOcean App Platform](#digitalocean-app-platform) + - [What You'll Need](#what-youll-need) +- [Features](#features) +- [Accessibility](#accessibility) + - [Accessibility Features](#accessibility-features) + - [Testing Accessibility](#testing-accessibility) + - [Accessibility Best Practices for Comic Creators](#accessibility-best-practices-for-comic-creators) + - [Accessibility Score](#accessibility-score) +- [Project Structure](#project-structure) +- [Setup](#setup) +- [Environment Variables](#environment-variables) +- [Configuration](#configuration) + - [Global Settings](#global-settings) +- [Adding Comics](#adding-comics) + - [Adding a New Comic](#adding-a-new-comic) + - [Generating RSS Feed](#generating-rss-feed) + - [Markdown Support](#markdown-support) +- [Production Deployment](#production-deployment) + - [Option 1: Docker (Recommended)](#option-1-docker-recommended) + - [Option 2: Manual Deployment with Gunicorn](#option-2-manual-deployment-with-gunicorn) + - [Using a Reverse Proxy (Recommended)](#using-a-reverse-proxy-recommended) + - [Additional Production Considerations](#additional-production-considerations) +- [Upgrading to a Database](#upgrading-to-a-database) +- [Customization](#customization) + - [Branding](#branding) + - [Styling](#styling) + - [About Page](#about-page) + - [Icon Navigation](#icon-navigation) + - [Social Links](#social-links) + - [Shareable Banner](#shareable-banner) +- [Navigation](#navigation) + - [Mouse/Touch Navigation](#mousetouch-navigation) + - [Keyboard Navigation](#keyboard-navigation) +- [Pages](#pages) +- [API Endpoints](#api-endpoints) +- [Credits](#credits) +- [License & Content Ownership](#license--content-ownership) + ## What is This? **Sunday Comics** is a simple, ready-to-use website for publishing your webcomic online. If you're an artist or comic creator who wants to share your work on the web without dealing with complex platforms or databases, this is for you.