Giki requires a file called Giki.json inside your repository documentation directory in order to
download the Hugo theme correctly.
The content of the files requires a theme JSON object which describes the theme you want to use.
The following snipped is an generic exmaple how the file could look like:
{
"theme": {
"repo": "https://github.com/[owner]/[repo].git",
"commit": "[commit_hash]"
}
}
2. Write your documentation (probably already done)
Well, simply write your documentation code with the synax of your picked theme.
There are no limitations or requirements Giki made!
3. Update the baseURL inside your config.yml
The baseURL in your config.[toml|yaml|json] file has to match the following syntax:
https://[owner]-[repo].getgiki.wiki
4. Call our builder endpoint
If your repository is setup correctly you can either put your repository link into the field above
or call our builder endpoint with curl:
curl "https://giki.vercel.app/build?repo=[owner]/[repo]"
5. Visit your documentation website
Configurations! 🎉 You're done.
If everything is setup correctly and the deployment was successfully you can visit your generated website at
https://[owner]-[repo].getgiki.wiki