Welcome to the Taikun documentation repository. This repository contains the source files for Taikun's official documentation.
This documentation includes:
-
Getting started guides
-
User guides and tutorials
-
Terraform provider documentation
-
Best practices and examples
-
Troubleshooting guides
To preview the documentation locally:
- Install the Taikun docs CLI:
npm i -g @taikun/docs-cli
- Run the development server:
taikun-docs dev
Visit http://localhost:3000
to preview the documentation.
If you encounter any issues:
- Make sure you're using Node.js v18 or later
- Try running
taikun-docs install
to reinstall dependencies - Clear the cache by removing the
~/.taikun-docs
folder
We welcome contributions! Please see our contributing guidelines for more information.