{"id":15200108,"url":"https://github.com/devich/quick","last_synced_at":"2025-09-01T08:36:14.033Z","repository":{"id":233515027,"uuid":"787354006","full_name":"devich/quick","owner":"devich","description":"The Quick theme magically transforms your README.md into a GitHub Pages site, applying clean and visually appealing styles. The fastest and easiest way to create a GitHub Pages website for your project.","archived":false,"fork":false,"pushed_at":"2024-05-11T21:13:12.000Z","size":299,"stargazers_count":16,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-06T03:41:10.177Z","etag":null,"topics":["github-pages","github-pages-template","github-pages-theme","jekyll-theme","landing-page","readme-template"],"latest_commit_sha":null,"homepage":"https://devich.github.io/quick/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devich.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-16T11:15:20.000Z","updated_at":"2025-03-29T17:06:46.000Z","dependencies_parsed_at":"2024-04-22T11:51:38.681Z","dependency_job_id":null,"html_url":"https://github.com/devich/quick","commit_stats":null,"previous_names":["devich/jekyll-template-for-readme","devich/quick"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/devich/quick","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devich%2Fquick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devich%2Fquick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devich%2Fquick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devich%2Fquick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devich","download_url":"https://codeload.github.com/devich/quick/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devich%2Fquick/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273094225,"owners_count":25044440,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-pages","github-pages-template","github-pages-theme","jekyll-theme","landing-page","readme-template"],"created_at":"2024-09-28T02:41:28.172Z","updated_at":"2025-09-01T08:36:13.984Z","avatar_url":"https://github.com/devich.png","language":"HTML","readme":"# \u003cspan style=\"color: #ff201e\"\u003eQuick.\u003c/span\u003e The fastest and easiest way to\u0026nbsp;create a\u0026nbsp;GitHub Pages website for your project.\n#### The Quick theme magically transforms your `README.md` into a GitHub Pages site, applying clean and visually appealing styles.\n\n\u003cp class=\"ignore\"\u003eJust see it yourself\u0026thinsp;—\u0026thinsp;\u003ca href=\"https://devich.github.io/quick/\"\u003ethis page\u003c/a\u003e is the same \u003ccode\u003eREADME.md\u003c/code\u003e file you’re reading, but with the Quick theme applied:\u003c/p\u003e\n\n\u003ca class=\"ignore\" href=\"https://devich.github.io/quick/\"\u003e\u003cimg src=\"assets/img/preview.png\" alt=\"Quick preview\"\u003e\u003c/a\u003e\n\n## Quick start\n\n1. Make sure a `README.md` file exists in the root directory of your repo, and GitHub Pages is enabled in your repository settings.\n\n2. Create a file named `_config.yml` in the root directory of your repository. The file should contain the following content:\n```yaml\nremote_theme: devich/quick@0.0.1\n```\n\n3. That’s it! There is no step 3. You now have a GitHub Pages website that’s based on your `README.md` file. The changes will take effect some time after you commit and push your updates to the repository. Enjoy your new website!\n\n\n## Looking for a simple landing page for your project? \n\nNo problem! You’re not restricted to using `readme.md` as the index page of your site. Simply create a file named `index.md`, and this theme will use it as the home page. Feel free to create as many pages as you want and link them within your site.\n\nFor instance, if you need a home page and an ‘About’ page, create files named `index.md` and `about.md`. Inside the `index.md` file, you can link to your ‘About’ page like this:\n\n```md\n[About this project](about)\n```\n\n\n## Fine tuning\n### Additional settings in _config.yml\n\nYou can set additional parameters for the site in the `_config.yml` file.\n\nThe following options are available:\n\n- `lang:` sets the language of the site. E.g. `en-US`, `uk`, `pl`, `fr-CA` and so on. The default value is `en-US`.\n- `bg_color:` sets the background color of your website. Can be `dark`, `light` or `auto`. The default value is `auto`.\n- `theme_color:` sets the main accent color for buttons, links, etc. It can be \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#c52f21\"\u003ered\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#d92662\"\u003epink\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#c0208a\"\u003efuchsia\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#9136a3\"\u003epurple\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#7540be\"\u003eviolet\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#524ed1\"\u003eindigo\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#2060de\"\u003eblue\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#0172ac\"\u003eazure\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#047878\"\u003ecyan\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#007a50\"\u003ejade\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#398712\"\u003egreen\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#a5d601\"\u003elime\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#f2df0d\"\u003eyellow\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#ffbf00\"\u003eamber\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#ff9500\"\u003epumpkin\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#d24317\"\u003eorange\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#ccc6b4\"\u003esand\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#ababab\"\u003egrey\u003c/code\u003e,\u003c/nobr\u003e \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#646b79\"\u003ezinc\u003c/code\u003e or \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#525f7a\"\u003eslate\u003c/code\u003e.\u003c/nobr\u003e The default value is \u003cnobr\u003e\u003ccode class=\"highlighter-rouge\" style=\"color:#0172ac\"\u003eazure\u003c/code\u003e.\n- `title:` sets the title of the site. If not set, your repository name will be used.\n- `description`: sets the meta description tag, which typically contains a concise, relevant summary of the page’s content.\n- `keywords`: sets keywords for the page, separated with commas.\n- `gtag`: sets your Google Analytics tag if needed (e.g. G-A1BCDEFGHI).\n\nAlternatively, you can copy the contents of the `_config.yml` file from the [theme repository](https://github.com/devich/quick/blob/main/_config.yml) into your own `_config.yml` file. This will give you access to all available options at once.\n\n\n\n### Ignoring\n\nIf there’s a block in the `README.md` file that you don’t want to display on the GitHub Pages site, you can format this block as HTML and assign the `class=\"ignore\"` attribute to it.\n\n\u003cp class=\"ignore\"\u003e\n    This paragraph \u003ca href=\"https://devich.github.io/quick/\"\u003ewill not be displayed\u003c/a\u003e\n    on the site because it has an \u003ccode\u003e\"ignore\"\u003c/code\u003e class.\n\u003c/p\u003e\n\n```html\n\u003cp class=\"ignore\"\u003e\n    This paragraph \u003ca href=\"https://devich.github.io/quick/\"\u003ewill not be\n    displayed\u003c/a\u003e on the site because it has an \u003ccode\u003e\"ignore\"\u003c/code\u003e class.\n\u003c/p\u003e\n```\n\n\n### More customization\n\nIf you need to use your own CSS styles, create a file `assets/css/custom.css` in your repository and add your styles to it.\n\nFor a custom favicon, just place your file in `PNG` format at `assets/img/favicon.png`.\n\nFor full control, clone this repository and modify the template as you need.","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevich%2Fquick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevich%2Fquick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevich%2Fquick/lists"}