https://github.com/trypear/pearai-documentation
Documentation page of PearAI using Docusaurus
https://github.com/trypear/pearai-documentation
documentation pearai
Last synced: 8 months ago
JSON representation
Documentation page of PearAI using Docusaurus
- Host: GitHub
- URL: https://github.com/trypear/pearai-documentation
- Owner: trypear
- Created: 2024-08-25T18:56:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-29T05:53:52.000Z (over 1 year ago)
- Last Synced: 2025-01-29T06:30:22.819Z (over 1 year ago)
- Topics: documentation, pearai
- Language: JavaScript
- Homepage: https://trypear.ai/docs
- Size: 54.9 MB
- Stars: 12
- Watchers: 3
- Forks: 22
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# PearAI Docs
Markdown content exists in the `docs/` folder, nested as it will be shown in the sidebar. `docusaurus.config.js` defines important footer, sidebar, and title content for the site.
This project is deployed through a separate Vercel project, but is used by the landing page at https://trypear.ai/docs/. In the `vercel.json` of the landing page, there's a redirect for the URL to be for this documentation page.
The reason we need a separate repository is because when included in the landing page, configurations from the outer directory mess up the Vercel deployment build.
## How to run
1. Fork repository and clone
2. Make a .env file in the root directory and copy over contents from .env.example
3. `npm install`
4. `npm run build`
5. `npm run serve`
To run it with hot reload: `npm run start`