gitbook-plugin-multilingual-index
v1.0.3
Published
customize multilingual home pages
Downloads
12
Maintainers
Readme
Welcome to gitbook-plugin-multilingual-index 👋
customize multilingual home pages
Usage
Step #1 - Update book.json
file
- In you gitbook's
book.json
file, addmultilingual-index
toplugins
list. - In
pluginsConfig
, SetenableSuper
asfalse
to disable default home page,and addindex
value to customize multilingual home pages. Only relative paths are supported.
Here is simplest example :
{
"plugins": ["multilingual-index"],
"pluginsConfig": {
"multilingual-index": {
"enableSuper": false,
"index":"index.html"
}
}
}
Please refer to the following configuration item for more details :
"enableSuper": {
"type": "boolean",
"title": "inherit from super",
"required": false,
"default": true
},
"index": {
"type": "string",
"title": "default index path",
"required": false
}
Step #2 - gitbook commands
- Run
gitbook install
. It will automatically installmultilingual-index
gitbook plugin for your book. This is needed only once.
gitbook install
or you can run npm install gitbook-plugin-multilingual-index
to install locally.
npm install gitbook-plugin-multilingual-index
- Build your book (
gitbook build
) or serve (gitbook serve
) as usual.
gitbook serve
Author
👤 snowdreams1006
- Website: snowdreams1006.tech
- Github: @snowdreams1006
- Email: [email protected]
Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Show your support
Give a Star if this project helped you!
Copyright
Copyright © 2019 snowdreams1006.
This project is MIT licensed.