logos-storage-docs/README.md

80 lines
2.0 KiB
Markdown
Raw Normal View History

2025-02-12 12:23:26 +01:00
# Documentación de Codex
2025-02-12 12:23:26 +01:00
Bienvenido a la documentación de Codex.
2025-02-12 12:23:26 +01:00
Codex es una plataforma descentralizada de almacenamiento de datos que ofrece una gran resistencia a la censura y sólidas garantías de durabilidad.
2025-02-12 12:23:26 +01:00
## Ejecutar y construir
2025-02-12 12:23:26 +01:00
Para la documentación, utilizamos [VitePress](https://vitepress.dev/), que es un generador de sitios web estáticos impulsado por [Vue](https://vuejs.org/) construido sobre [Vite](https://vitejs.dev/).
2025-02-12 12:23:26 +01:00
Para ejecutar el sitio localmente, debemos clonar el repositorio, instalar las dependencias y ejecutar el siguiente comando:
2025-02-12 12:23:26 +01:00
```shell
npm run docs:dev
```
<details>
2025-02-12 12:23:26 +01:00
<summary>Guía detallada</summary>
2025-02-12 12:23:26 +01:00
1. [Instala](https://nodejs.org/en/download/package-manager) node 20 o [superior](https://nodejs.org/en/about/previous-releases)
2025-02-12 12:23:26 +01:00
Usando [nvm](https://github.com/nvm-sh/nvm)
```shell
# nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
# Node 22
nvm install 22
nvm use 22
# Check
node --version
v22.6.0
```
2025-02-12 12:23:26 +01:00
2. Clona el repositorio
```shell
git clone https://github.com/codex-storage/codex-docs
cd codex-docs
```
2025-02-12 12:23:26 +01:00
3. Instala las dependencias
2024-09-28 23:47:47 +03:00
```shell
npm install
```
2025-02-12 12:23:26 +01:00
4. Inicia un servidor de desarrollo local con actualizaciones instantáneas
```shell
# Local
npm run docs:dev
# Expose
npm run docs:dev -- --host
```
2025-02-12 12:23:26 +01:00
5. [Genera el sitio web](https://vitepress.dev/guide/deploy)
```shell
npm run docs:build
# .vitepress/dist
```
</details>
2025-02-12 12:23:26 +01:00
## Contribuir
2025-02-12 12:23:26 +01:00
Por favor, consulta la [documentación de VitePress](https://vitepress.dev/) para obtener más información sobre las opciones de personalización.
2025-02-12 12:23:26 +01:00
Proceso:
2025-02-12 12:23:26 +01:00
* Haz un fork del repositorio.
* Crea una rama (branch) en tu fork.
* Añade tu contribución.
* Envía un pull request (PR) al repositorio upstream.
Estructura del proyecto:
- `learn` - Toda la información para aprender sobre Codex.
- `networks` - Información relacionada con las redes de Codex.
- `developers` - Proceso de desarrollo y guías de Codex.