Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgee-cloud/docs
Edgee Documentation website
https://github.com/edgee-cloud/docs
docs edge edgee http wasm wasm-component
Last synced: 30 days ago
JSON representation
Edgee Documentation website
- Host: GitHub
- URL: https://github.com/edgee-cloud/docs
- Owner: edgee-cloud
- License: apache-2.0
- Created: 2023-07-18T02:03:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-06T16:54:31.000Z (about 1 month ago)
- Last Synced: 2024-12-06T17:38:34.143Z (about 1 month ago)
- Topics: docs, edge, edgee, http, wasm, wasm-component
- Language: MDX
- Homepage: https://docs.edgee.cloud
- Size: 7.87 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Edgee Documentation, made with mintlify
Edgee Documentation is a [Mintlify](https://mintlify.com/) project. The documentation is the main entry point for Edgee users.
## Prerequisites:
- **Have NodeJS installed** (we use nvm to manage the NodeJS version)#### QuickStart Linux/OSx Dev:
```bash
## Go wherever you want
git clone [email protected]:edgee-cloud/docs.git
cd docs
nvm use
make dev.up ## This command will start the docs
```
VOILA !!!Then you can go to https://localhost:3001
### Publishing Changes
Changes will be deployed to production automatically after pushing to the `main` branch.
#### Troubleshooting
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`