{"id":15983010,"url":"https://github.com/princesseuh/hugo-royal-theme","last_synced_at":"2026-01-20T04:32:22.089Z","repository":{"id":109681677,"uuid":"137707934","full_name":"Princesseuh/hugo-royal-theme","owner":"Princesseuh","description":"✨📚 Pretty theme for pretty documentations","archived":false,"fork":false,"pushed_at":"2020-08-03T12:59:41.000Z","size":471,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-13T15:35:48.055Z","etag":null,"topics":["documentation-theme","hugo","hugo-theme"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/Princesseuh.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-18T03:55:16.000Z","updated_at":"2020-08-03T12:59:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"adb922fd-85e5-4e97-aa48-1cca4ca08f55","html_url":"https://github.com/Princesseuh/hugo-royal-theme","commit_stats":{"total_commits":12,"total_committers":3,"mean_commits":4.0,"dds":0.25,"last_synced_commit":"baafd1d247902c76dd5d8773fb66fe6a98ac70fa"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Princesseuh/hugo-royal-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princesseuh%2Fhugo-royal-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princesseuh%2Fhugo-royal-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princesseuh%2Fhugo-royal-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princesseuh%2Fhugo-royal-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Princesseuh","download_url":"https://codeload.github.com/Princesseuh/hugo-royal-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princesseuh%2Fhugo-royal-theme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28596079,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T02:08:49.799Z","status":"ssl_error","status_checked_at":"2026-01-20T02:08:44.148Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation-theme","hugo","hugo-theme"],"created_at":"2024-10-08T01:24:09.866Z","updated_at":"2026-01-20T04:32:22.065Z","avatar_url":"https://github.com/Princesseuh.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Royal Theme for Hugo\n\n![Preview](github_assets/light_dark.png)\n\nThis is a port of the [Sphinx theme of the same name](https://github.com/Princesseuh/sphinx-royal-theme) I made for the French RPG Maker community RPG Maker Alliance (RMA). Even though Hugo is mostly used for blogs, it does documentations pretty well!\n\nThe theme is responsive and should work on every platform. However it is centered and has a fixed max width. The theme is currently available in English and French (see the i18n folder)\n\nYou can see a live example running at [wiki.gamedevalliance.com](https://wiki.gamedevalliance.com)\n\n\n## Installation\n\n**Royal require the extended version of Hugo**. Clone the repo inside the themes folder of your Hugo installation like so :\n\n```bash\ncd themes\ngit clone https://github.com/princesseuh/hugo-royal-theme\n```\n\nAlternatively you can add the theme as a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), making it easier for other users to pull your repo\n\nThen in your site's `config.toml`, set the theme :\n\n```toml\ntheme = \"hugo-royal-theme\"\n```\n\nAnd there you go! You should now have a working installation using this beautiful theme. Check below for more information on how to enable and customize all of its features.\n\n\n## Configuration\n\nThis theme does not require any specific setting to work, however certain features are disabled if certain files or parameters are missing. Unlike the Sphinx version, there's no RMA branded assets included in the theme\n\n\n### Menus\n\nRoyal uses [Hugo's Menus](https://gohugo.io/content-management/menus/) feature to generate the header and left sidebar menus (the right sidebar however is automatically generated from the table of content)\n\nFor the header, the menu is called `global`. You can populate it by editing your `config.toml` file like so :\n\n```toml\n[[menu.global]]\nname = \"Website\"\nweight = 1\nidentifier = \"website\"\nurl = \"https://princesseuh.net\"\n\n[[menu.global]]\nname = \"Twitter\"\nweight = 2\nidentifier = \"twitter\"\nurl = \"https://twitter.com/VanillaHoys\"\n```\n\nThe header menu currently doesn't support parents and submenus.\n\nFor the left sidebar, the menu is called `docs`. Like for the header, you can populate it by editing the `config.toml`, however only childs will actually be clickable (there is currently no way to change this)\n\nSo for instance, to add a link through the config file you need to do it like this :\n\n```toml\n[[menu.docs]]\nname = \"GitHub Links\"\nidentifier = \"meta\"\n\n[[menu.docs]]\nname = \"Source Code\"\nparent = \"meta\"\nurl = \"https://github.com/princesseuh/hugo-royal-theme\"\n```\n\nWhich will result in this :\n\n![Example Menu](github_assets/sidebar-menu-example.png)\n\n(The GitHub icon is automatically added to GitHub links in the left sidebar)\n\nTo add a menu entry through a page's front matter, see [this page](https://gohugo.io/content-management/menus/#add-content-to-menus) from the Hugo documentation\n\n\n#### Removing the trailing slash in URLs (Experimental)\n\nHugo currently does not support natively removing the trailing slash from URLs. However, Go's templates are powerful enough to be able to do it ourselves!\n\nTo try it out, add\n```toml\n[params]\nremoveTrailingSlash = true\n```\n\nto your `config.toml`.\n\nTake note that this will also affect external links and canonical url meta tags. However it won't touch the ref and relref shortcodes, you'll have to make your own. ([Example](https://github.com/rpgmakeralliance/wiki/blob/master/layouts/shortcodes/ref.html))\n\n\n### Adding a logo\n\nPut an image called `logo.png` in `{SITE_ROOT}/static/assets/`. Royal will automatically use it for the header instead of writing the website name\n\n\n### Adding a favicon\n\nLike for the logo, Royal checks if a file called `favicon.png` exists in `{SITE_ROOT}/static/assets/`. Royal currently does not support having multiple formats and sizes for favicon\n\n\n### \"Edit this page\" link\n\nThe Edit this page link (both in the sidebar and in the shortcode) requires `editURL` to be set in the params section of your `config.toml` file. Like so :\n\n```toml\n[params]\neditURL = \"https://github.com/rpgmakeralliance/wiki/edit/master/content\"\n```\n\nThe current page link will be appended to this link, so make sure it point to your content folder without a trailling slash!\n\n\n### SEO\n\n#### OpenGraph Icon\n\nUnless a page-specific OpenGraph icon is specified (see [Specify an OpenGraph icon](#specify-an-opengraph-icon)), Royal will automatically use a file called `default_opengraph.png` located in `{SITE_ROOT}/static/assets/` if it exist.\n\nCurrently, for Twitter Cards, the `summary` type of card is hardcoded in `baseof.html`\n\n\n#### Twitter Handler\n\nIn your site `config.toml` file, simply add\n\n```toml\n[social]\ntwitter = \"YOUR_TWITTER_HANDLE\"\n```\n\nDon't add the at (@) sign, Royal will add it automatically\n\n## Page Parameters\n\nA few parameters are supported to disable certain features or change the opengraph icon on a per page basis\n\n\n### Disable the \"Edit this Page\" link\n\nAdd `editthispage: false` to your page's front matter\n\n\n### Disable the right sidebar\n\nAdd `onthispage: false` to your page's front matter\n\n\n### Specify an OpenGraph icon\n\nAdd `og_image: \"{IMAGE_URL}\"` to your page's front matter\n\n\n### Limit Table of Content depth\n\nAdd `tocmaxdepth: {DEPTH}` to your page's front matter. Only values from 1 to 5 are currently supported\n\nUnfortunately it's not yet possible in Hugo to limit the Table of Content depth natively so we had to do it through CSS (which is why it's limited to specific values)\n\n\n## Licenses\n\nThis theme is distributed under the MIT license. You can see the details [here](LICENSE.md)\n\n### External Resources\n- [Normalize.css by Nicolas Gallagher](https://github.com/necolas/normalize.css) under the [MIT](https://github.com/necolas/normalize.css/blob/master/LICENSE.md) license\n- [Dark Mode Icon by Rami McMin](https://www.flaticon.com/free-icon/moon-phase-outline_53381) under the [CC 3.0 BY](https://creativecommons.org/licenses/by/3.0/) license\n- [Source Sans Pro font by Adobe](https://fonts.google.com/specimen/Source+Sans+Pro) under the [Open Font License](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi\u0026id=OFL_web)\n- Various icons (menu, permalinks, external links etc) from [Font-Awesome](https://fontawesome.com/) built into a custom bundle using [Fontello](http://fontello.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincesseuh%2Fhugo-royal-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprincesseuh%2Fhugo-royal-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincesseuh%2Fhugo-royal-theme/lists"}