Añadir Nuevos Ejemplos de Código
Guía de Contribución para Ejemplos de Código
- Las publicaciones deben estar escritas en inglés.
- Documente su ejemplo lo más detalladamente posible.
- Asegúrese de que su código funcione y haya sido probado correctamente.
Nos reservamos el derecho de:
- Modificar su publicación después de ser enviada.
- Eliminar su publicación si es necesario.
Crear un Nuevo Ejemplo de Código
1. Haga un fork de este repositorio
2. Clone su fork y haga cd en el directorio del proyecto
3. Instala VitePress
Puedes encontrar los requisitos previos de VitePress en la documentación oficial.
sh
npm add -D vitepress@nextsh
pnpm add -D vitepress@nextsh
yarn add -D vitepress@next vuesh
bun add -D vitepress@next4. Añada su ejemplo de código
4.1 Crea el archivo de ejemplo
- Cree un nuevo archivo en
/docs/examplesnombrado con el nombre del lenguaje de programación. - El nombre del archivo debe terminar en
.md. - Incluye al menos dos formas diferentes de realizar llamadas a la API.
4.2 Añada el ejemplo a la barra lateral
- Abra
/docs/.vitepress/config.mts. - Localice la sección "Code Examples" en la barra lateral.
- Añada su nuevo archivo a la lista.
- Mantén la lista en orden alfabético por lenguaje de programación.
5. Inicia el Servidor de Desarrollo
Antes de crear un pull request, verifique localmente que sus cambios no hayan roto nada.
sh
npm run devsh
pnpm run devsh
yarn devsh
bun run dev6. Crea un Pull Request
Envía un pull request al repositorio original.