-
Notifications
You must be signed in to change notification settings - Fork 14
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
1 parent
20c0a2e
commit 086e253
Showing
1 changed file
with
30 additions
and
27 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,40 +1,43 @@ | ||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
<p align="center"> | ||
<img src="https://files.liara.ir/liara/logos/download.svg" alt="Liar Logo" /> | ||
</p> | ||
|
||
## Getting Started | ||
--- | ||
|
||
First, run the development server: | ||
This is the **official** documentation of [Liara](https://liara.ir), which is also available at [docs.liara.ir](https://docs.liara.ir). You can have your own documentation by following the steps below: | ||
|
||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
# or | ||
pnpm dev | ||
# or | ||
bun dev | ||
1. Clone the repository: | ||
``` | ||
git clone https://github.com/liara-cloud/docs.git | ||
``` | ||
|
||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
|
||
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. | ||
|
||
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`. | ||
|
||
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. | ||
2. Navigate to the directory: | ||
``` | ||
cd docs | ||
``` | ||
|
||
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
3. Make sure you have [NodeJS & npm](https://nodejs.org/en) installed. If not, please install them before proceeding. | ||
|
||
## Learn More | ||
4. Install the dependencies: | ||
``` | ||
npm install | ||
``` | ||
|
||
To learn more about Next.js, take a look at the following resources: | ||
5. Run the development server: | ||
``` | ||
npm run dev | ||
``` | ||
6. Open your browser and go to `http://localhost:3001`. | ||
and ... That's it! | ||
|
||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
## Branches | ||
- [master](https://github.com/liara-cloud/docs/tree/master): This is the main documentation of Liara | ||
- [old-docs](https://github.com/liara-cloud/docs/tree/old-docs): This is the old version of Liara's documentation | ||
|
||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
## Getting Help | ||
If you have questions, please [create a ticket](https://console.liara.ir/tickets/create) | ||
|
||
## Deploy on Vercel | ||
--- | ||
|
||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
Feel free to contribute! | ||
|
||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |