{"id":15511246,"url":"https://github.com/bep/docuapi","last_synced_at":"2025-05-14T18:07:33.807Z","repository":{"id":12182191,"uuid":"71171466","full_name":"bep/docuapi","owner":"bep","description":"Beautiful multilingual API documentation theme for Hugo","archived":false,"fork":false,"pushed_at":"2025-04-13T16:41:13.000Z","size":1827,"stargazers_count":766,"open_issues_count":18,"forks_count":201,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-14T14:59:36.156Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docuapi.netlify.app/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null},"funding":{"github":["bep"]}},"created_at":"2016-10-17T19:02:31.000Z","updated_at":"2025-04-13T16:38:51.000Z","dependencies_parsed_at":"2024-11-02T20:03:13.094Z","dependency_job_id":"45b05bcc-10ae-4e5d-bb17-cd16d8670e43","html_url":"https://github.com/bep/docuapi","commit_stats":{"total_commits":168,"total_committers":15,"mean_commits":11.2,"dds":0.1428571428571429,"last_synced_commit":"6dc844e596c4ca24c8de943e4625e7884b62f210"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bep%2Fdocuapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bep%2Fdocuapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bep%2Fdocuapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bep%2Fdocuapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bep","download_url":"https://codeload.github.com/bep/docuapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254198514,"owners_count":22030966,"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":[],"created_at":"2024-10-02T09:52:56.249Z","updated_at":"2025-05-14T18:07:28.798Z","avatar_url":"https://github.com/bep.png","language":"HTML","funding_links":["https://github.com/sponsors/bep"],"categories":["HTML"],"sub_categories":[],"readme":"[![Netlify Status](https://api.netlify.com/api/v1/badges/49111249-0a1a-4b5a-a3ab-45d00732fdb3/deploy-status)](https://app.netlify.com/sites/docuapi/deploys)\n\n**DocuAPI** is a beautiful multilingual API documentation theme for [Hugo](http://gohugo.io/). This theme is built on top of the beautiful work of [Robert Lord](https://github.com/lord) and others on the [Slate](https://github.com/slatedocs/slate) project ([Apache 2 License](https://github.com/slatedocs/slate/blob/master/LICENSE)). The JS part has recently been rewritten from Jquery to [AlpineJS](https://alpinejs.dev/).\n\n\u003cbr/\u003e\n\n\u003e Visit the [demo site](https://docuapi.netlify.app/).\n\n\u003cbr/\u003e\n\n![Screenshot DocuAPI Example site](https://raw.githubusercontent.com/bep/docuapi/master/images/screenshot.png)\n\n## Use\n\nImport the theme in your Hugo config:\n\n```toml\n[[module.imports]]\npath = \"github.com/bep/docuapi/v2\"\n```\n\nNote, if you want the older jQuery-version, replace the path with `github.com/bep/docuapi`.\n\nIf you want to edit the SCSS styles, you need:\n\n* The extended Hugo version.\n* PostCSS CLI (run `npm install` to install requirements)\n\nSee the [exampleSite](https://github.com/bep/docuapi/tree/master/exampleSite) and more specific its site [configuration](https://github.com/bep/docuapi/blob/master/exampleSite/hugo.toml) for the available options.\n\n**Most notable:** This theme will use all the (non drafts) pages in the site and build a single-page API documentation. Using `weight` in the page front matter is the easiest way to control page order.\n\nIf you want a different page selection, please provide your own `layouts/index.html` template.\n\nYou can customize the look-and-feel by adding your own CSS variables in `assets/scss/docuapi_overrides.scss`. See the exampleSite folder for an example.\n\n## Hooks\n\nYou can override the layouts by providing some custom partials:\n\n* `partials/hook_head_end.html` is inserted right before the `head` end tag. Useful for additional styles etc.\n* `partials/hook_body_end.html` which should be clear by its name.\n* `partials/hook_left_sidebar_start.html` the start of the left sidebar\n* `partials/hook_left_sidebar_end.html` the end of the left sidebar\n* `partials/hook_left_sidebar_logo.html` the log `img` source\n\nThe styles and Javascript import are also put in each partial and as such can be overridden if really needed:\n\n* `partials/styles.html`\n* `partials/js.html`\n\n## Stargazers over time\n\n[![Stargazers over time](https://starchart.cc/bep/docuapi.svg)](https://starchart.cc/bep/docuapi)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbep%2Fdocuapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbep%2Fdocuapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbep%2Fdocuapi/lists"}