This repo provides a basis for your custom Elevio KB.
The best place to start is the Quick Start Guide.
git clone [email protected]:dixahq/kb-typescript-starter.gitThis file gives you control over certain features in your Knowledge Base.
For detailed information on settings.json please visit our documentation: ClientSettings and the Quick Start Guide
You must ensure that you fill in an accountId in your settings.json file or the command line interface will fail when you try npm run start:
> npm run start
>
> @elevio/[email protected] start
> elevio-kb dev
fetching settings
Missing company UID headerYou can easily get your accountId from app.elev.io/account
When you want to work on a KB you will also need to create a .env file in its repo. This file is git ignored so you will have to create it for each KB you work on.
There is an example .env file named .env.example in the root dir.
To get the TOKEN you you will need to log into HQ as the account of the company you want to publish a KB for. Then visit the URL https://app.elev.io/token and grab the Permanent key.
See Deployment for more details
When you want to save a version of the KB you are working on to see it working on production you can run the following command.
npm run save
Make sure you run this from inside the directory containing the KB.
It will print out link that you can use to preview this version.
Once you are happy with the version you have previewed you can then set that version to be the live version by running the command
npm run deploy
It will ask you to select a saved version.