{"id":15044748,"url":"https://github.com/thomasheller/crab","last_synced_at":"2025-05-02T07:32:47.009Z","repository":{"id":55149930,"uuid":"85394186","full_name":"thomasheller/crab","owner":"thomasheller","description":"Crab theme for Hugo","archived":false,"fork":false,"pushed_at":"2021-02-26T20:06:44.000Z","size":723,"stargazers_count":26,"open_issues_count":2,"forks_count":23,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T23:04:42.717Z","etag":null,"topics":["hugo","hugo-theme"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thomasheller.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-18T10:48:37.000Z","updated_at":"2021-12-16T12:19:53.000Z","dependencies_parsed_at":"2022-08-14T13:31:23.307Z","dependency_job_id":null,"html_url":"https://github.com/thomasheller/crab","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasheller%2Fcrab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasheller%2Fcrab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasheller%2Fcrab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasheller%2Fcrab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thomasheller","download_url":"https://codeload.github.com/thomasheller/crab/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224305839,"owners_count":17289446,"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","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":["hugo","hugo-theme"],"created_at":"2024-09-24T20:50:59.202Z","updated_at":"2024-11-12T16:04:49.066Z","avatar_url":"https://github.com/thomasheller.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Crab\n\nCrab is a clean website theme for the [Hugo](https://gohugo.io) static\nsite generator.\n\n![Crab theme screenshot](https://raw.githubusercontent.com/thomasheller/crab/master/images/screenshot.png)\n\n## Features\n\n- responsive\n- nested menus\n- two-column\n- tag support\n- blog articles\n\n## Preview\n\nIf you'd like to get a live demo of the Crab theme locally, you could\nclone the repository, cd to the `exampleSite` directory and run\n`HUGO_THEMESDIR=../.. hugo serve -t crab` from there (assuming\n[Hugo](http://gohugo.io) is already installed).\n\n## Installation\n\nRead the [Hugo Quickstart\nGuide](https://gohugo.io/overview/quickstart/) for an introduction to\nHugo itself. Once you created a new Hugo site, you can use the Crab\ntheme.\n\nIn your Hugo site's folder:\n\n```sh\n$ git clone https://github.com/thomasheller/crab themes/crab\n```\n\nAlternatively, if your site is in a git repository, you can use git\nsubmodules:\n\n```sh\n$ git submodule add https://github.com/thomasheller/crab themes/crab\n```\n\nTo update the theme to the latest version, simply pull in the changes:\n\n```sh\n$ git -C themes/crab pull\n```\n\n## Usage\n\nThe file `exampleSite/config.toml` provides an example for how the\nCrab theme can be configured, especially in regard to the menu items.\n\nOnce you put a `config.toml` in your site's root directory, you can\nget a preview of your Hugo site as usual:\n\n```sh\n$ hugo serve -t crab\n```\n\n## Menus\n\nSee the `exampleSite/config.toml` file for how the menus can be\nconfigured:\n\n- Use the `weight` attribute to specify the order of menu items.\n  Menu items with smaller numbers appear before those with bigger\n  numbers.\n- For every menu, specify an `identifier` if you intend the menu to\n  have sub-items. In each sub-item, make sure the `parent` attribute\n  matches the value of the `identifier` used for the parent menu.\n- Choose a unique `name` for each item in the same menu.\n\n## Two-column layout\n\nLook at the `exampleSite/content/home.md` file for a sidebar example.\nIf you put a shortcode like this at the beginning of your content\nfile, the summary will appear in the right column:\n\n```md\n{{\u003c summary \u003e}}\nThis appears in the sidebar. *Markdown* is supported!\n{{\u003c /summary \u003e}}\n```\n\n## Tags\n\nTags are supported as [taxonomies described in the Hugo\nmanual](https://gohugo.io/taxonomies/usage/). Make sure your config\nfile contains a proper `taxonomies` declaration, like in the\n`exampleSite/config.toml`. You can then put tags in the front matter\nas usual:\n\n```\n+++\ntitle = \"A Page With Tags\"\ntags = [ \"Hugo\", \"theme\", \"Crab\" ]\n...\n```\n\nTags will appear both on regular (fixed, static) pages as well as for\nblog posts, although they are probably more commonly used with blog\nposts.\n\n## Blog\n\nBlog posts are intended to be created in the special directory\n`/blog/`. The main difference about blog articles is that the layout\nincludes the timestamp when they were published (fixed pages don't\nshow a timestamp by default) and that they appear in the list of blog\narticles.\n\nThe `exampleSites/config.toml` shows the kind of `permalinks`\ndeclaration required to generate blog posts in the correct place.\n\n## Logo\n\nTo change the logo of the crab to your own customised image,\nadd `logoimage` to `config.toml`, where `logoimage` is the\npath inside your site's `static` directory.\n\n## Contact\n\nIf you think anything could be improved about the Crab theme, feel\nfree to [send a PR](https://github.com/thomasheller/crab) to the Crab\nrepository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomasheller%2Fcrab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthomasheller%2Fcrab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomasheller%2Fcrab/lists"}