{"id":13431020,"url":"https://github.com/zalando-incubator/hexo-theme-doc","last_synced_at":"2025-10-06T11:30:39.528Z","repository":{"id":57263778,"uuid":"107538778","full_name":"zalando-incubator/hexo-theme-doc","owner":"zalando-incubator","description":"A documentation theme for the Hexo blog framework","archived":true,"fork":false,"pushed_at":"2020-04-15T12:29:40.000Z","size":2892,"stargazers_count":245,"open_issues_count":19,"forks_count":56,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-05-20T09:18:31.576Z","etag":null,"topics":["api","api-docs","api-documentation","api-documentation-tool","documentation","documentation-theme","documentation-tool","hexo-theme","rest-api-documentation","static-site-generator","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"https://zalando-incubator.github.io/hexo-theme-doc","language":"JavaScript","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/zalando-incubator.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2017-10-19T11:42:44.000Z","updated_at":"2024-05-20T09:18:31.576Z","dependencies_parsed_at":"2022-08-25T02:20:53.295Z","dependency_job_id":null,"html_url":"https://github.com/zalando-incubator/hexo-theme-doc","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalando-incubator%2Fhexo-theme-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalando-incubator%2Fhexo-theme-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalando-incubator%2Fhexo-theme-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalando-incubator%2Fhexo-theme-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zalando-incubator","download_url":"https://codeload.github.com/zalando-incubator/hexo-theme-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219877262,"owners_count":16554852,"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","api-docs","api-documentation","api-documentation-tool","documentation","documentation-theme","documentation-tool","hexo-theme","rest-api-documentation","static-site-generator","swagger","swagger-ui"],"created_at":"2024-07-31T02:00:59.862Z","updated_at":"2025-10-06T11:30:34.156Z","avatar_url":"https://github.com/zalando-incubator.png","language":"JavaScript","funding_links":[],"categories":["Content","JavaScript","documentation"],"sub_categories":[],"readme":"hexo-theme-doc\n==============\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![dependencies Status](https://david-dm.org/zalando-incubator/hexo-theme-doc/status.svg)](https://david-dm.org/zalando-incubator/hexo-theme-doc)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0a927311457a4180a4d7606a8f66ab5f)](https://www.codacy.com/app/bhaskarmelkani/hexo-theme-doc)\n[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/0a927311457a4180a4d7606a8f66ab5f)](https://www.codacy.com/app/bhaskarmelkani/hexo-theme-doc)\n[![Build Status](https://travis-ci.org/zalando-incubator/hexo-theme-doc.svg?branch=master)](https://travis-ci.org/zalando-incubator/hexo-theme-doc)\n[![npm version](https://badge.fury.io/js/hexo-theme-doc.svg)](https://badge.fury.io/js/hexo-theme-doc)\n\n**LiveDemo:** [https://zalando-incubator.github.io/hexo-theme-doc](https://zalando-incubator.github.io/hexo-theme-doc)\n\nhexo-theme-doc is a **documentation theme** for [Hexo](https://hexo.io/), the fast and powerful blog framework powered by Node.js. It differs from other Hexo themes by allowing you to present documentation—especially REST API documentation.\n\nCreated by JavaScript/Node.js developers, hexo-theme-doc capitalizes on Hexo's [extensibility](https://hexo.io/api/) and system of plugins for adding custom tags, customizing layouts, and processing multiple kinds of sources, which makes generating static websites simpler than other tools.\n\nhexo-theme-doc's features include:\n\n* A clean and responsive layout\n* Search\n* [Swagger](https://swagger.io/) integration\n  * Support for [Swagger UI](https://zalando-incubator.github.io/hexo-theme-doc/usage-and-configuration/swagger-ui.html)\n  * Ability to generate [beautiful HTML API references](https://zalando-incubator.github.io/hexo-theme-doc/usage-and-configuration/swagger-to-html.html) *(this feature is in beta phase)*.\n* Simple, configurable navigation, including for Tables of Contents\n* Google Analytics\n* Customizable logo and favicon\n\nVisit our **[demo](https://zalando-incubator.github.io/hexo-theme-doc)** to view an example of hexo-theme-doc in action.\n\n[![Theme Mockup](./mockup.png)](https://zalando-incubator.github.io/hexo-theme-doc)\n\n### Table of Contents\n\n* [Get Started](#get-started)\n* [Feature Roadmap](#feature-roadmap)\n* [Contributing](#contributing)\n* [Development](#development)\n* [Credits](#credits)\n* [License](#license)\n\n## \u003ca name=\"get-started\"\u003e\u003c/a\u003e Get Started\n\nOur [step-by-step guide](https://zalando-incubator.github.io/hexo-theme-doc/get-started.html) aims to get you running with hexo-theme-doc in five minutes or less.\n\nFor a deeper dive, check our **[user documentation](https://zalando-incubator.github.io/hexo-theme-doc)**.\n\n## \u003ca name=\"feature-roadmap\"\u003e\u003c/a\u003e Feature Roadmap\n\nhexo-theme-doc is currently in development at [Zalando](https://jobs.zalando.com/tech/) and useful out-of-the-box to others. We welcome suggestions/feedback and [contributions](./CONTRIBUTING.md), especially on these planned features:\n\n* More sophisticated control over navigation/automatic filesystem-based navigation (**community feedback priority**)\n* Swagger to HTML *(this feature is in beta phase)*\n  * Make implementation more robust, and covering all edge cases (**development priority**)\n  * Support for Swagger 3.0\n  * Ability to fetch Swagger files from remote locations\n  * Ability to provide request/response examples in an external file\n  * Exclusion of APIs/operations from output\n  * Markdown content support\n\nFor more info on our progress, visit the [changelog](./CHANGELOG.md) contributions.\n\n## \u003ca name=\"contributing\"\u003e\u003c/a\u003e Contributing\n\nThere are many ways to contribute to hexo-theme-doc:\n\n* give a github star to the project\n* create github issues and help us to find bugs and/or request features.\n* contribute to the source code\n\nPlease check our [CONTRIBUTING](./CONTRIBUTING.md) guidelines.\n\n## \u003ca name=\"development\"\u003e\u003c/a\u003e Development\n\nTo get started with hexo-theme-doc **development**, you need to install [NodeJS](https://nodejs.org/en/) and [Git](https://git-scm.com/). Then install `hexo-cli` globally:\n\n```\n$ npm install hexo-cli -g\n```\n\nGet the theme source and install the dependencies:\n\n```bash\n$ git clone git@github.com:zalando-incubator/hexo-theme-doc.git\n$ cd hexo-theme-doc \u0026\u0026 npm install\n```\n\nEnsure that you can successfully run test and linting tasks:\n\n```\n$ npm run test \u0026\u0026 npm run lint\n```\n\nIf you want to update the visual aspects of your front-end, we suggest using our [user documentation](https://zalando-incubator.github.io/hexo-theme-doc) site as a playground for previewing your changes. First, [link](https://docs.npmjs.com/cli/link) the theme package globally with:\n\n```\n$ cd hexo-theme-doc \u0026\u0026 npm link\n```\n\nThen get the user documentation source:\n\n```\n$ git clone git@github.com:zalando-incubator/hexo-theme-doc.git hexo-theme-doc-site\n$ cd hexo-theme-doc-site\n$ git fetch --all \u0026\u0026 git checkout gh-pages-source\n$ npm install\n```\n\n\u003e The documentation source resides in this repository as well but just on a different branch called: `gh-pages-source`\n\nNow [link](https://docs.npmjs.com/cli/link) the theme package as a dependency (this will use your local version):\n\n```bash\n$ npm link hexo-theme-doc\n```\n\nFinally run the built-in server:\n\n```bash\n$ hexo s\n```\n\nOpen your browser at http://localhost:4000, and hopefully you'll see the documentation site up and running.\n\n### Test\n\nRun tests with Facebook's [Jest](https://facebook.github.io/jest/) (currently the only testing tool compatible with hexo-theme-doc):\n\n```\n$ npm run test\n```\n\nTo generate coverage reports run:\n\n```\n$ npm run test:coverage\n```\n\nReports are generated at `target/coverage`.Sometimes you'll only need to run one test suite focused on a single problem; do that by running:\n\n```\n$ npm run test -- \u003cregexp\u003e\n```\n\n`\u003cregexp\u003e` represents a Regular Expression, matching test file path(s)—eg. `npm run jest -- search*`.\n\n### Lint\n\nLint the code using [ESLint](http://eslint.org/) (currently the only linting tool compatible with hexo-theme-doc):\n\n```\n$ npm run lint\n```\n\nTo apply automatic fixes to your code, run it with the `--fix` option:\n\n```\n$ npm run lint --fix\n```\n\n### Compile\n\nUse [Webpack](https://github.com/webpack/webpack) and [node-sass](https://github.com/sass/node-sass) to compile your JavaScript source and style source for the browser:\n\n```\n$ npm run compile\n```\n\n**!!! ALWAYS !!!** compile and commit distribution artifacts after updating Javascript and/or SCSS files.\n\n### Release \u003csmall\u003e(recommended workflow)\u003c/small\u003e\n\nOnly the [maintainers](./MAINTAINERS)** perform releases. Our preferred workflow:\n\n1. Bump version in `package.json`\n2. Run `npm run prerelease`\n3. Commit and push\n4. Open a PR\n5. When PR is merged, tag and push\n\n## \u003ca name=\"credits\"\u003e\u003c/a\u003e Credits\n\n* Thanks to [Esin Isik](https://www.linkedin.com/in/esinis/) for helping us out with **Design** and **UX**\n* Thanks to Royyan Razka from the Noun Project for the logo\n* Some similar projects that inspired us: [hexo-theme-meteor](https://github.com/meteor/hexo-theme-meteor), [slate](https://github.com/lord/slate), [gitbook](https://github.com/GitbookIO/gitbook), [readthedocs theme](https://github.com/rtfd/sphinx_rtd_theme).\n\n## \u003ca name=\"license\"\u003e\u003c/a\u003e License\n\nMIT license with exceptions. See the [full license](./LICENSE) for details.\n\nCopyright 2017, Zalando SE\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalando-incubator%2Fhexo-theme-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzalando-incubator%2Fhexo-theme-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalando-incubator%2Fhexo-theme-doc/lists"}