Welcome to the official documentation for Korepi. Below you'll find links to various resources including the live version of the documentation, the website, and how to get started with testing the project locally.
- Korepi GitHub Repository: Visit here
- Live Documentation: View here
To view the Korepi documentation online, you can either:
- Visit the official website.
- Use the backup documentation link if the main site is unavailable.
To set up the Korepi documentation for local testing and development, follow these steps:
- Install NodeJS: Ensure you have NodeJS version 18 or higher installed. You can download it from NodeJS official website.
- Clone the Repository: Use GitHub Desktop or the Git command line (
git clone) to clone the repository. - Install Dependencies: Navigate to the project's root directory and run
pnpm installto install the required dependencies.
To test the documentation locally:
- Execute
pnpm run docs:devin the root directory of the project. - By default, the documentation will be accessible at
http://localhost:8080.
For selecting icons to use within the Korepi documentation or projects, explore the vast collection available at FontAwesome.
Thank you for contributing to and using Korepi. For more information or if you encounter issues, please refer to the GitHub repository issues section.