{"id":21461569,"url":"https://github.com/snowdreams1006/gitbook-plugin-multilingual-index","last_synced_at":"2025-08-23T18:05:01.898Z","repository":{"id":47295149,"uuid":"226859110","full_name":"snowdreams1006/gitbook-plugin-multilingual-index","owner":"snowdreams1006","description":"customize multilingual home pages","archived":false,"fork":false,"pushed_at":"2024-08-15T06:56:55.000Z","size":5225,"stargazers_count":6,"open_issues_count":2,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-20T20:04:58.118Z","etag":null,"topics":["gitbook","gitbook-plugin","il8n","multilingual-index","multiple-languages"],"latest_commit_sha":null,"homepage":"https://snowdreams1006.github.io/gitbook-plugin-multilingual-index/","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/snowdreams1006.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-09T11:50:31.000Z","updated_at":"2024-08-15T06:56:58.000Z","dependencies_parsed_at":"2025-01-23T14:28:22.891Z","dependency_job_id":"1ea5d336-1e71-4f6d-bdae-3479e2a28f1a","html_url":"https://github.com/snowdreams1006/gitbook-plugin-multilingual-index","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/snowdreams1006/gitbook-plugin-multilingual-index","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-multilingual-index","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-multilingual-index/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-multilingual-index/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-multilingual-index/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snowdreams1006","download_url":"https://codeload.github.com/snowdreams1006/gitbook-plugin-multilingual-index/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-multilingual-index/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271760492,"owners_count":24816430,"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","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["gitbook","gitbook-plugin","il8n","multilingual-index","multiple-languages"],"created_at":"2024-11-23T07:09:48.349Z","updated_at":"2025-08-23T18:05:01.872Z","avatar_url":"https://github.com/snowdreams1006.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Welcome to gitbook-plugin-multilingual-index 👋\n\n[![npm:version](https://img.shields.io/npm/v/gitbook-plugin-multilingual-index.svg)](https://www.npmjs.com/package/gitbook-plugin-multilingual-index)\n[![npm:download](https://img.shields.io/npm/dt/gitbook-plugin-multilingual-index.svg)](https://www.npmjs.com/package/gitbook-plugin-multilingual-index)\n[![npm:prerequisite](https://img.shields.io/badge/gitbook-*-blue.svg)](https://www.npmjs.com/package/gitbook-plugin-multilingual-index)\n[![github:documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/snowdreams1006/gitbook-plugin-multilingual-index#readme)\n[![github:maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/snowdreams1006/gitbook-plugin-multilingual-index/graphs/commit-activity)\n[![npm:license](https://img.shields.io/npm/l/gitbook-plugin-multilingual-index.svg)](https://github.com/snowdreams1006/gitbook-plugin-multilingual-index/blob/master/LICENSE)\n[![github:snodreams1006](https://img.shields.io/badge/github-snowdreams1006-brightgreen.svg)](https://github.com/snowdreams1006)\n[![微信公众号:雪之梦技术驿站-brightgreen.svg](https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1%E5%85%AC%E4%BC%97%E5%8F%B7-%E9%9B%AA%E4%B9%8B%E6%A2%A6%E6%8A%80%E6%9C%AF%E9%A9%BF%E7%AB%99-brightgreen.svg)](https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg)\n\n\u003e customize multilingual home pages\n\n## Usage\n\n### Step #1 - Update `book.json` file\n\n1. In you gitbook's `book.json` file, add `multilingual-index` to `plugins` list.\n2. In `pluginsConfig`, Set `enableSuper` as `false` to disable default home page,and add `index` value to customize multilingual home pages. Only relative paths are supported.\n\nHere is simplest example :\n\n```json\n{\n    \"plugins\": [\"multilingual-index\"],\n    \"pluginsConfig\": {\n        \"multilingual-index\": {\n            \"enableSuper\": false,\n            \"index\":\"index.html\"\n        }\n    }\n}\n```\n\nPlease refer to the following configuration item for more details : \n\n```json\n\"enableSuper\": {\n  \"type\": \"boolean\",\n  \"title\": \"inherit from super\",\n  \"required\": false,\n  \"default\": true\n},\n\"index\": {\n  \"type\": \"string\",\n  \"title\": \"default index path\",\n  \"required\": false\n}\n```\n\n### Step #2 - gitbook commands\n\n1. Run `gitbook install`. It will automatically install `multilingual-index` gitbook plugin for your book. This is needed only once.\n\n```bash\ngitbook install\n```\n\nor you can run `npm install gitbook-plugin-multilingual-index` to install locally.\n\n```bash\nnpm install gitbook-plugin-multilingual-index\n```\n\n2. Build your book (`gitbook build`) or serve (`gitbook serve`) as usual.\n\n```bash\ngitbook serve\n```\n\n## Author\n\n👤 **snowdreams1006**\n\n- Website: [snowdreams1006.tech](https://snowdreams1006.tech/)\n- Github: [@snowdreams1006](https://github.com/snowdreams1006)\n- Email: [snowdreams1006@163.com](mailto:snowdreams1006@163.com)\n\n## Contributing\n\nContributions, issues and feature requests are welcome!\n\nFeel free to check [issues page](https://github.com/snowdreams1006/gitbook-plugin-multilingual-index/issues).\n\n![snowdreams1006-wechat-donate.jpg](https://snowdreams1006.github.io/snowdreams1006-wechat-donate.jpg)\n\n## Show your support\n\nGive a **[Star](https://github.com/snowdreams1006/gitbook-plugin-multilingual-index)** if this project helped you!\n\n![snowdreams1006-wechat-donate.jpg](https://snowdreams1006.github.io/snowdreams1006-wechat-donate.jpg)\n\n## Copyright\n\nCopyright © 2019 [snowdreams1006](https://github.com/snowdreams1006).\n\nThis project is [MIT](https://github.com/snowdreams1006/gitbook-plugin-multilingual-index/blob/master/LICENSE) licensed.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-multilingual-index","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-multilingual-index","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-multilingual-index/lists"}