-
Notifications
You must be signed in to change notification settings - Fork 305
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
icah m
committed
Aug 19, 2024
1 parent
10aa49e
commit 2d78679
Showing
2 changed files
with
16 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1 @@ | ||
# Korepi Documentation | ||
|
||
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. | ||
|
||
## Quick Links | ||
|
||
- **Korepi GitHub Repository:** [Visit here](https://github.com/Korepi/korepi) | ||
- **Live Documentation:** [View here](https://github.com/Korepi/korepi-docs) | ||
|
||
## Viewing the Documentation Online | ||
|
||
To view the Korepi documentation online, you can either: | ||
|
||
- Visit the [official website](https://korepi.com/). | ||
- Use the [backup documentation link](https://docs.korepi.com/) if the main site is unavailable. | ||
|
||
## Local Testing and Development | ||
|
||
### Setting Up for the First Time | ||
|
||
To set up the Korepi documentation for local testing and development, follow these steps: | ||
|
||
1. **Install NodeJS:** Ensure you have NodeJS version 18 or higher installed. You can download it from [NodeJS official website](https://nodejs.org/en/download/). | ||
2. **Clone the Repository:** Use [GitHub Desktop](https://desktop.github.com/) or the Git command line (`git clone`) to clone the repository. | ||
3. **Install Dependencies:** Navigate to the project's root directory and run `pnpm install` to install the required dependencies. | ||
|
||
### Running Locally | ||
|
||
To test the documentation locally: | ||
|
||
1. Execute `pnpm run docs:dev` in the root directory of the project. | ||
2. By default, the documentation will be accessible at `http://localhost:8080`. | ||
|
||
## Additional Resources | ||
|
||
### Icon Selection | ||
|
||
For selecting icons to use within the Korepi documentation or projects, explore the vast collection available at [FontAwesome](https://fontawesome.com/search). | ||
|
||
--- | ||
|
||
Thank you for contributing to and using Korepi. For more information or if you encounter issues, please refer to the GitHub repository issues section. | ||
# This document moved to https://github.com/boreki/korepi-docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters