diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..25b3bde --- /dev/null +++ b/README.md @@ -0,0 +1,131 @@ +# Source code para construir tu página web en texto-plano.xyz + +Realizado con [Jekyll](https://jekyllrb.com) y un CSS propio, por +[~santisoler](https://texto-plano.xyz/~santisoler) + +## Como armar mi propio sitio web + +### Clonar el repositorio + +Comenzamos por clonar este repositorio utilizando `git`: + +``` +git clone https://git.texto-plano.xyz/santisoler/website-template mi-sitio-web +``` + +Entramos a la carpeta en la que clonamos el repositorio: + +``` +cd mi-sitio-web +``` + +Dentro de esta carpeta encontramos el código fuente para construir nuestro +sitio web. + +### Configurando el sitio + +Primero vamos a editar r el archivo `_config.yml`. +Vamos a configurar el título del sitio y el nickname del autor: + +``` +title: ~santisoler +author: ~santisoler +``` + +Dado que nuestro sitio en texto-plano no está alojado en el root del website, +es necesario configurar el baseurl, que en general debe ser igual a una barra +(`/`) seguida de nuestro nombre de usuario con el tilde: + +``` +baseurl: /~santisoler +``` + +Luego podemos editar el `index.md` para agregar contenido al home de nuestro +sitio. Por ejemplo, podemos escribir algo acerca de nosotros y listar nuestros +perfiles en la red. + +### Añadiendo contenido + +Podemos añadir contenido a nuestro sitio web a través de archivos Markdown. Por +ejemplo, si queremos añadir una nueva entrada a nuestro blog, debemos crear un +archivo en `_posts` cuyo nombre esté compuesto por la fecha de publicación +y luego un nombre sencillo, por ejemplo: + +``` +touch _posts/2021-03-22-mi-primer-posteo.md +``` + +Cada entrada del blog debe tener un header (en YAML) y luego el contenido (en +Markdown). Por ejemplo: + + --- + title: Mi primer posteo + layout: post + excerpt: | + Este es un resumen de mi posteo + --- + + Acá puedo escribir mi entrada del blog usando Markdown. + Puedo armar listas: + + - un elemento + - otro elemento + + O listas numeradas: + + 1. Primer elemento + 2. Segundo elemento + + + Con enlaces, por ejemplo a [Wikipedia](https://www.wikipedia.org). + + O bien podemos crear código: + + ``` + echo "Aguante texto-plano" + ``` + +### Construir el sitio + +Una vez que generamos contenido nuevo, vamos a proceder a construir el sitio +web. Esto lo podemos hacer a través de Jekyll: + +``` +bundle exec jekyll serve +``` + +Este comando generará una carpeta `_site` que contiene todos los archivos +necesarios para servir nuestro sitio web. +Lo único que queda para que lo publiquemos es copiar todos los archivos de esa +carpeta en `~/public_html/`. + +``` +cp -r _site/* ~/public_html/ +``` + +A veces será necesario quitar el sitio web viejo que está siendo servido +y reemplazarlo por el nuevo: + +**USAR ESTE COMANDO CON CUIDADO!** + +``` +rm -r ~/public_html/* +cp -r _site/* ~/public_html/ +``` + +Recuerda que cada vez que creemos una nueva entrada de nuestro blog o hagamos +cualquier modificación a nuestro sitio, lo haremos en los archivos ubicados en +`mi-sitio-web`. Mientras que el contenido de `~/public_html` solo será aquel +que cree automáticamente Jekyll. + + + +## Licencia + +Contenido bajo +[Licencia Creative Commons Atribución 4.0 Internacional][cc-by]. + +[![CC BY 4.0][cc-by-image]][cc-by] + +[cc-by]: https://creativecommons.org/licenses/by/4.0/deed.es +[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png |