{"id":41843088,"url":"https://github.com/krakend/krakend-documentation","last_synced_at":"2026-01-25T09:39:33.268Z","repository":{"id":38105707,"uuid":"126084572","full_name":"krakend/krakend-documentation","owner":"krakend","description":"All the documentation under http://www.krakend.io/docs/","archived":false,"fork":false,"pushed_at":"2026-01-19T18:10:01.000Z","size":2945,"stargazers_count":25,"open_issues_count":2,"forks_count":120,"subscribers_count":6,"default_branch":"master","last_synced_at":"2026-01-19T21:48:51.496Z","etag":null,"topics":["documentation","krakend","markdown"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/krakend.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":"security/_index.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-03-20T21:26:43.000Z","updated_at":"2026-01-19T15:29:19.000Z","dependencies_parsed_at":"2024-04-22T17:47:13.027Z","dependency_job_id":"caad4a3e-a663-4f34-92dc-e6d3761ae23d","html_url":"https://github.com/krakend/krakend-documentation","commit_stats":null,"previous_names":["devopsfaith/krakend-documentation","krakend/krakend-documentation","krakendio/krakend-documentation"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/krakend/krakend-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krakend%2Fkrakend-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krakend%2Fkrakend-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krakend%2Fkrakend-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krakend%2Fkrakend-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/krakend","download_url":"https://codeload.github.com/krakend/krakend-documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krakend%2Fkrakend-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28750886,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T09:00:19.176Z","status":"ssl_error","status_checked_at":"2026-01-25T09:00:04.131Z","response_time":113,"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","krakend","markdown"],"created_at":"2026-01-25T09:39:33.212Z","updated_at":"2026-01-25T09:39:33.264Z","avatar_url":"https://github.com/krakend.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# KrakenD Documentation\nAll the documentation uses Markdown syntax and the site is generated using [Hugo](https://gohugo.io). After your contribution this repository will be used to compile all the documentation.\n\nIf you want to use a server to browse this pages, although not necessary, you can copy the folder inside the `content` directory in any Hugo installation.\n\n# Contribute!\nFeel free to fork this repository and contribute to a better KrakenD documentation.\n\nIf you'd like to add a new language please open an issue before doing the work as we will need to add the support before it is visible.\n\nThanks for improving the docs!\n\n# Helpers when writing\nBesides from the regular Markdown to write content, there are a few shortcodes to help you style the documentation:\n\n**Add a yellow note**:\n\nFor important notes, and things that need special, attention:\n\n    {{\u003c note title=\"A note on JWT generation\" \u003e}}\n    Some big yellow block with a note\n    {{\u003c /note \u003e}}\n\n**Show terminal output**:\n\nThe CSS will prepend a dollar sign `$` in the first line.\n\n    {{\u003c terminal title=\"Title of the box\"\u003e}}\n    docker build -t mykrakend .\n    Sending build context to Docker daemon   5.12kB\n    Step 1/2 : FROM devopsfaith/krakend\n    ---\u003e c7e33ec819c0\n    Step 2/2 : COPY krakend.json /etc/krakend/krakend.json\n    ---\u003e 703818e9de3a\n    Successfully built 703818e9de3a\n    Successfully tagged mykrakend:latest\n    {{\u003c /terminal \u003e}}\n\n**Highlight some code**:\n\nMost of the code is just idented with a tab and Markdown renders it properly as a `\u003cpre\u003e` tag and we prefer not to colorize it much. Nevertheless this can be done with the following shortcode:\n\n    {{\u003c highlight json \u003e}}\n    { \"a\": true }\n    {{\u003c /highlight \u003e}}\n\nYou can also highlight a line, specific lines `6 7`, or a range `6-8`:\n\n    {{\u003c highlight go \"hl_lines=6-7\" \u003e}}\n    package krakend\n\n    import (\n        \"github.com/devopsfaith/krakend/logging\"\n        client \"github.com/devopsfaith/krakend/transport/http/client/plugin\"\n        server \"github.com/devopsfaith/krakend/transport/http/server/plugin\"\n    )\n    {{\u003c /highlight \u003e}}\n\nThe documentation of the attributes is autoloaded from its json schema definition. You will find lines like the following:\n\n    {{\u003c schema data=\"folder/file.json\" \u003e}}\n\nThe `data` attribute loads the file from the [`krakend-schema` repository](https://github.com/krakendio/krakend-schema), using the same path.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrakend%2Fkrakend-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkrakend%2Fkrakend-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrakend%2Fkrakend-documentation/lists"}