https://github.com/peeramid-labs/docs
documentation portal
https://github.com/peeramid-labs/docs
Last synced: 3 months ago
JSON representation
documentation portal
- Host: GitHub
- URL: https://github.com/peeramid-labs/docs
- Owner: peeramid-labs
- Created: 2024-06-01T16:34:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-25T06:43:32.000Z (3 months ago)
- Last Synced: 2025-02-25T07:39:54.926Z (3 months ago)
- Language: Shell
- Homepage: https://docs.rankify.it/
- Size: 15.2 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Support: docs/support/faq.md
- Governance: docs/governance.md
Awesome Lists containing this project
README
# Peeramid Documentation
This repository contains the documentation for the Peeramid project, built using MkDocs.
## Project Structure
```
docs/
├── docs/ # Documentation source files
├── css/ # Custom CSS styles
├── bin/ # Scripts and binaries
├── site/ # Built documentation site
└── mkdocs.yml # MkDocs configuration
```
## Setup
1. Create and activate a virtual environment:
```bash
python -m venv .venv
source .venv/bin/activate # On Unix/macOS
```
2. Install Python dependencies:
```bash
pip install -r requirements.txt
```
3. Install Node.js dependencies:
```bash
pnpm install
```
## Development
To serve the documentation locally:
```bash
mkdocs serve
```
This will start a development server at `http://127.0.0.1:8000`.
## Deployment
The documentation can be deployed using the provided script:
```bash
./deploy-docs.sh
```
## Scripts
- `copy-contract-docs.sh`: Script for copying contract documentation
- `deploy-docs.sh`: Script for deploying the documentation site
## Requirements
- Python 3.x
- Node.js
- pnpm package manager
For detailed Python dependencies, see `requirements.txt`.