Creación de una base de conocimientos personal - Basada en Docusaurus
Continuando desde el artículo anterior Por qué necesitas una base de conocimientos, en este artículo, vamos a realizar una explicación detallada sobre la construcción de una base de conocimientos utilizando el marco Docusaurus.
Antes de comenzar con este artículo, asegúrate de tener lo siguiente preparado:
- Acceso a Internet sin restricciones.
- La capacidad de adaptarse a situaciones cambiantes.
- Un conocimiento básico de inglés.
Configuración del entorno local
Instalación de Node.js
Visita el sitio web oficial de Node.js y descarga e instala Node.js.
Instalación y configuración de VS Code
Utilizaremos VS Code como editor local para modificar el marco del sitio y escribir artículos.
En primer lugar, descarga e instala VS Code desde el sitio web oficial de VS Code.
Una vez que la instalación del software esté completa, puedes optar por instalar los siguientes dos complementos:
- Paquete de idioma chino simplificado: Esto traducirá la interfaz de VS Code al chino simplificado.
- Markdown All in One: Proporciona un mayor soporte para la sintaxis Markdown.
Después de instalar los complementos, es posible que necesites reiniciar VS Code según las indicaciones.
Para obtener instrucciones más detalladas sobre la configuración, puedes consultar el artículo Guía de productividad de VS Code - Configuración del entorno.
Instalación del marco Docusaurus
Dirígete al directorio donde deseas crear el proyecto del sitio web.
Por ejemplo, si quieres crear un proyecto de base de conocimientos en una carpeta llamada "wiki" en la unidad D de tu computadora, abre VS Code, selecciona "Archivo" - "Abrir carpeta", elige la unidad D y selecciona la carpeta "wiki".
Utiliza el comando npx para inicializar el sitio web:
Por ejemplo, si el nombre de la carpeta de tu proyecto de sitio web es "wiki", sustituye "[nombre]" por "wiki" y, según la documentación oficial, "[plantilla]" se refiere al tema de la plantilla del sitio web. En este caso, puedes sustituirlo por "classic". Por lo tanto, el comando que debes ejecutar es el siguiente:
Dentro de VS Code, utiliza el atajo de teclado Ctrl + ` para abrir la terminal, pega la línea de código anterior y pulsa Enter. Espera pacientemente a que se complete la carga.
Cuando la carga se complete, utiliza el siguiente comando en la terminal para cambiar al directorio del proyecto del sitio web:
Sustituye "[nombre]" por el nombre de la carpeta de tu proyecto de sitio web, que en nuestro caso es "wiki" según el paso anterior.
Luego, ejecuta el siguiente comando:
Esto iniciará la implementación local del sitio web. Después de que se complete la implementación, se abrirá automáticamente la página localhost:3000 en tu navegador. Si todo sale bien, verás que el sitio web se ha generado con éxito.
Implementación del sitio web en la nube
En el paso anterior, logramos generar con éxito el sitio web, pero solo se desplegó localmente y no se puede acceder a él desde Internet. Necesitamos desplegar el sitio web en un servidor en la nube para que otros usuarios puedan acceder a él desde Internet.
Registrar una cuenta en GitHub
Regístrese en el sitio web de GitHub.
Instalar Git
Descargue el software Git desde el sitio web oficial de Git y realice la instalación.
Reinicie VS Code, abra la terminal y pegue los siguientes comandos para inicializar Git:
git config --global user.name "nombre_de_usuario"
git config --global user.email "correo@example.com"
En este punto, reemplace "nombre_de_usuario" con su nombre de usuario de Git, se recomienda que coincida con el nombre de usuario que acaba de registrar en GitHub, por ejemplo, yo lo reemplacé con linyuxuanlin. De manera similar, reemplace "correo@example.com" con la dirección de correo electrónico que utilizó para registrarse en GitHub.
Para obtener instrucciones de configuración más detalladas, consulte este artículo Notas de aprendizaje de Git (en chino).
Configurar el repositorio del proyecto en VS Code
Para poder enviar los cambios a GitHub en el siguiente paso, necesitamos configurar el repositorio Git del proyecto en VS Code y subirlo a GitHub.
Dentro de VS Code, use la combinación de teclas Ctrl + Shift + G para abrir la interfaz de gestión de código fuente, inicialice el repositorio Git del proyecto y realice el primer commit.
Luego, use la combinación de teclas Ctrl + Alt + S para enviar el repositorio Git local a GitHub (siga las indicaciones para iniciar sesión en su cuenta de GitHub).
Usar Vercel para desplegar el sitio web en la nube
La funcionalidad de Vercel aquí es equivalente a GitHub Actions + GitHub Pages, es decir, despliegue continuo automático y presentación de sitios web estáticos. Se elige Vercel debido a que la velocidad de acceso a los sitios web estáticos generados por Vercel es mucho más rápida en comparación con GitHub Pages, especialmente en China.
En primer lugar, visite directamente la página de inicio de sesión de GitHub de Vercel y registre una cuenta de Vercel utilizando su cuenta de GitHub.
Una vez completado, haga clic en "Nuevo Proyecto" en el sitio web de Vercel e importe el repositorio correspondiente de GitHub (por ejemplo, el repositorio "wiki" que creamos anteriormente). Es posible que deba seguir las indicaciones y volver a iniciar sesión en GitHub. Después de la importación, simplemente haga clic en "Siguiente" y, en poco tiempo, su sitio web estará desplegado con éxito.
Resumen
En este artículo, logramos desplegar una base de conocimiento basada en Docusaurus tanto localmente como en la nube. Si encuentra algún problema durante este proceso, no dude en ponerse en contacto conmigo en WeChat. En el próximo artículo (pendiente de actualización), explicaré en detalle la configuración personalizada.
Referencias y Agradecimientos
Dirección original del artículo: https://wiki-power.com/ Este artículo está protegido por la licencia CC BY-NC-SA 4.0. Si desea reproducirlo, por favor indique la fuente.
Este post está traducido usando ChatGPT, por favor feedback si hay alguna omisión.