2. Publicar notas de Obsidian con Docsify y GitHub Pages
Publicar un proyecto en GitHub
Esta guía se centra en la creación de un proyecto en GitHub para usar las notas de Obsidian con Docsify y GitHub Pages.
- Sube la carpeta a un repositorio
Crea un repositorio nuevo (o usa uno existente) y sube el contenido de la carpeta que deseas usar directamente en la raíz del repositorio, no dentro de una subcarpeta adicional.
Opción A — Crear un repositorio nuevo desde la línea de comandos
git init
git add .
git commit -m "first commit"
git branch -M master
git remote add origin URL_del_repositorio
git push -u origin master
Opción B — Subir a un repositorio existente
git remote add origin URL_del_repositorio
git branch -M master
git push -u origin master
- Archivos obligatorios
Es importante que la carpeta a usar tenga estos archivos en la raíz:
README.mdindex.html_sidebar.md.nojekyll
Estos son necesarios para que Docsify funcione correctamente.
⚠️ El archivo
.nojekyllempieza con punto, así que GitHub (o tu explorador de archivos) puede ocultarlo al arrastrar archivos por la interfaz web. Verifica que sí se haya subido; si no, súbelo por línea de comandos con git.
- Activa GitHub Pages
En el repositorio, ve a Settings → Pages. En Source, selecciona la rama (main o master, según tu caso) y la carpeta raíz (/root). Guarda los cambios.
- Espera el despliegue y abre la URL
GitHub tarda uno o dos minutos en publicar. La URL será algo como:
https://tu-usuario.github.io/nombre-del-repositorio/
Ábrela y confirma que el sidebar cargue con tus notas.
- Prueba la navegación y el buscador
- Haz clic en cada enlace del sidebar para confirmar que los espacios en los nombres de archivo no rompan la ruta.
- Prueba el buscador (ya viene configurado en tu
index.html) para verificar que indexe el contenido de la carpetaSummary.
- Crear .gitignore
En caso de que algunos archivos den error se pueden agregar al archivo .gitignore para evitar conflictos.
# Crear archivo vacío
echo "" > .gitignore
# O agregar reglas directamente
echo ".obsidian/" > .gitignore
echo "*.log" >> .gitignore
echo ".DS_Store" >> .gitignore
echo "Thumbs.db" >> .gitignore
# Crear .gitignore con tus reglas (una línea)
echo -e ".obsidian/\n*.log\n.DS_Store\nThumbs.db" > .gitignore
Agregar reglas a un .gitignore existente
# Agregar una sola regla
echo "node_modules/" >> .gitignore
# Agregar múltiples reglas de una vez
echo -e ".obsidian/\n*.log\n.DS_Store\nThumbs.db" >> .gitignore
Ver qué está siendo ignorado
git status --ignored
Verificar si un archivo específico está ignorado
# Verifica si app.log está ignorado
git check-ignore -v app.log
Publicar cambios
Una vez que el repositorio ya está creado y conectado con origin, no necesitas repetir git init ni git remote add. Cada vez que edites una nota, agregues un archivo nuevo o modifiques el _sidebar.md, solo necesitas estos tres comandos:
git add .
git commit -m "Descripción breve del cambio"
git push
# Para evitar conflictos
git pull origin master # Primero, trae los cambios del remoto
git push origin master # Si no hay conflictos, el pull se hará automáticamente
git add .→ toma todos los archivos nuevos o modificados en la carpeta.git commit -m "..."→ guarda esos cambios en el historial local con un mensaje que describa qué cambiaste (ej. "Agrega nota de Wh Questions" o "Corrige sidebar").git push→ sube los cambios al repositorio en GitHub.
💡 GitHub Pages detecta el
pushautomáticamente y vuelve a desplegar el sitio en uno o dos minutos, sin que tengas que repetir la configuración de Settings → Pages. Solo actualiza la página en el navegador (a veces conviene forzar el refresco conCtrl+F5oCmd+Shift+Rsi el navegador guardó una versión en caché).
Si es solo un archivo en especifico, puedes usar:
git add _sidebar.md
git commit -m "Cambios en sidebar"
git push
Si quieres confirmar que solo ese archivo quedó en staging antes de hacer commit, puedes correr:
git status
Eliminar las configuraciones de GitHub de una carpeta
- Eliminar solo la carpeta
.git
Esto elimina todo el historial de Git y las configuraciones, pero mantiene tus archivos:
rm -rf .git
- Limpiar solo configuraciones específicas
Si quieres mantener el repositorio pero eliminar configuraciones específicas:
# Eliminar el remote de GitHub
git remote remove origin
# O eliminar todos los remotes
git remote remove $(git remote)
# Eliminar configuraciones específicas del repositorio
git config --local --unset-all user.name
git config --local --unset-all user.email
# Eliminar todas las configuraciones locales
git config --local --remove-section user
- Verificar que se eliminó correctamente
Después de ejecutar cualquiera de estos comandos, verifica:
# Verificar si ya no es un repositorio Git
git status
# Debería mostrar: "fatal: not a git repository"
# Verificar que la carpeta .git ya no existe
ls -la | grep .git
# No debería mostrar resultados