{"id":14979535,"url":"https://github.com/laurencee9/jekyll-flat-api","last_synced_at":"2025-10-28T18:31:48.385Z","repository":{"id":52297756,"uuid":"127954507","full_name":"laurencee9/jekyll-flat-api","owner":"laurencee9","description":"A Jekyll theme for API documentation","archived":false,"fork":false,"pushed_at":"2021-04-30T22:09:47.000Z","size":1013,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-03T19:18:12.212Z","etag":null,"topics":["api-documentation","jekyll","jekyll-theme"],"latest_commit_sha":null,"homepage":"https://jekyll-theme-api-documentation.github.io","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/laurencee9.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}},"created_at":"2018-04-03T18:53:41.000Z","updated_at":"2022-11-28T13:10:27.000Z","dependencies_parsed_at":"2022-08-20T11:40:34.275Z","dependency_job_id":null,"html_url":"https://github.com/laurencee9/jekyll-flat-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurencee9%2Fjekyll-flat-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurencee9%2Fjekyll-flat-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurencee9%2Fjekyll-flat-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laurencee9%2Fjekyll-flat-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/laurencee9","download_url":"https://codeload.github.com/laurencee9/jekyll-flat-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238700455,"owners_count":19515933,"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":["api-documentation","jekyll","jekyll-theme"],"created_at":"2024-09-24T14:00:14.664Z","updated_at":"2025-10-28T18:31:47.811Z","avatar_url":"https://github.com/laurencee9.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jekyll flat API\r\n\r\nA Jekyll theme for API documentation. It is inspired by the beautifully designed API of \u003ca href=\"https://unsplash.com/documentation\"\u003eunsplash\u003c/a\u003e. \r\n\r\n[**Click here for demo**](https://jekyll-theme-api-documentation.github.io)\r\n\r\n![](./assets/images/example1.png) \r\n\r\n\r\n## Usage\r\n\r\nSimply run\r\n\r\n```\r\njekyll server\r\n```\r\n\r\nIf something goes wrong, follow the instruction from [jekyll](https://jekyllrb.com/docs/themes/).\r\n\r\n\r\n## Creating content\r\n\r\nThe content of the API is located in `_documentation`. You can create as many folders as you want to organize your API. In each subfolder of `_documentation`, you may find markdown files. \r\n\r\n### Jekyll tags\r\n\r\nFiles with `front: true` in their header will be presented as sections leaders in the navigation bar. Those leaders can be ordered using the `order: ` tag in the markdown file. For example, `_documentation/photos/photos.md` is the leader of the photo section. \r\n\r\nIt is very important that the files with `front: false` have a permalink such that it contains the permalink of its section leader. \r\n\r\n### Image\r\n\r\nThe top image and the main title can be modified in `_includes/home.html`. \r\n\r\n### Navbar\r\n\r\nThe API status url in the navbar can be modified in `_includes/nav.html`\r\n\r\n### Thumbnails\r\n\r\nAt the top of the page, you may find small squares. You can create them using the tag `thumbnail: true` in the mardown files. You can have as many as you like.\r\n\r\n## Style\r\n\r\nIf you want to modify the style, have a look at `_sass/layout.scss`. At the top, you will find variables that control most of the colors.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaurencee9%2Fjekyll-flat-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaurencee9%2Fjekyll-flat-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaurencee9%2Fjekyll-flat-api/lists"}