Newsletter
Join the Community
Subscribe to our newsletter for the latest news and updates
A Jekyll theme for GitHub Pages that converts a repository's README.md into a clean, styled project website.
A full-stack Next.js TypeScript template focused on functionality over UI, featuring Zustand, TanStack Query, and ESLint 9 support.
Quick is a GitHub Pages remote Jekyll theme by developer devich that turns a repository's root README.md into a styled project website with a one-line _config.yml entry and no local Jekyll installation.
Quick is a Jekyll remote theme built for GitHub Pages. It takes a plain markdown README.md file as input and renders it as the index page of a public GitHub Pages site, applying clean typography, layout, and color styling automatically. The theme is installed through GitHub's remote_theme mechanism, so you only commit configuration, not generated HTML. It is maintained by devich on GitHub, and the live demo is at https://devich.github.io/quick/.
remote_theme: devich/[email protected] to _config.yml; there is no step 3 in the quick-start instructions.README.md becomes the site's home page, so documentation stays in one place and the site updates on every push.theme_color with options including red, pink, fuchsia, purple, violet, indigo, blue, azure, cyan, jade, green, lime, yellow, amber, pumpkin, orange, sand, grey, zinc, and slate; default is azure.bg_color to dark, light, or auto (the default) to control the site's background appearance.index.md, about.md, or any other .md file in the root and link between pages with markdown links like [About this project](about).class="ignore", such as <p class="ignore">, and it is hidden from the rendered site.assets/css/custom.css for your own styles and assets/img/favicon.png for a custom favicon.title, description, keywords, and lang in _config.yml, plus a gtag field for Google Analytics.Quick is for GitHub users who want a project website without maintaining a separate site repository. Open-source maintainers can publish their README as the project page in minutes. Developers creating a landing page for a new repository can get a styled homepage by committing two files. Documentation-focused teams already using GitHub Pages can use it to stand up a documentation index quickly.
README.md into a public homepage and keep documentation and site content synchronized in one file._config.yml file once GitHub Pages is enabled in repository settings.about.md or index.md and link them from the README-driven landing page.remote_theme feature to avoid installing Ruby or Jekyll locally.The quick-start workflow has three steps: verify a README.md exists and GitHub Pages is enabled in repository settings; create a _config.yml in the root with remote_theme: devich/[email protected]; commit and push. GitHub Pages then builds the site using the Quick theme, and changes take effect after the next push. For more control, you can copy the contents of the theme's _config.yml from the GitHub repository to expose all options at once.
No. Quick uses the remote_theme feature, so GitHub Pages builds the site for you. You only need to commit a _config.yml file; no local Ruby or Jekyll installation is required.
Yes. Create any markdown file in the repository root, such as index.md or about.md, and link between pages using markdown links like [About this project](about). The theme automatically treats those files as pages on the site.
Set the theme_color option in _config.yml to one of the 20 supported names: red, pink, fuchsia, purple, violet, indigo, blue, azure, cyan, jade, green, lime, yellow, amber, pumpkin, orange, sand, grey, zinc, or slate. The default value is azure.
Yes. Wrap content you want to hide in an HTML block that has class="ignore", such as <p class="ignore">...</p>, and that block will not render on the GitHub Pages site.
