Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deberia incluirse el plugin lektor-markdown-header-anchors #421

Closed
andoresuperesu opened this issue Jul 23, 2023 · 10 comments · Fixed by #422
Closed

Deberia incluirse el plugin lektor-markdown-header-anchors #421

andoresuperesu opened this issue Jul 23, 2023 · 10 comments · Fixed by #422

Comments

@andoresuperesu
Copy link
Collaborator

Solicitud de mejora en sitio web PyBAQ

Deberia incluirse el plugin lektor-markdown-header-anchors en el repositorio.

Ventajas

Genera anchors a cada titulo de los articulos y da acceso a crear tablas de contenido. También permitiría hacer links especificos a secciones de otros articulos; lo que daria contexto a la relación entre articulos como "Contribuir en Modo Facil" y "Cómo contribuir en el blog de Python Barranquilla"

Desventajas

No encuentro desventajas hasta el momento. El plugin es mantenido por los mantainers de Lektor y el uso es muy específico. Puede ser útil a otros modelos de la pagina.

@pyjavo
Copy link
Member

pyjavo commented Jul 24, 2023

Excelente sugerencia
¿Visualmente como se vería esto? ¿De casualidad conoces una página que ya lo implemente para poder ver como quedaría?

Mi duda surge porque @Scot3004 en el PR #422 habla de una tabla (como en la documentación) o enlaces

@andoresuperesu
Copy link
Collaborator Author

andoresuperesu commented Jul 24, 2023

@pyjavo @Scot3004 Esto no crea tablas, sino que crea un id en los titulos de markdown con el slug del titulo.

HTML generado ahora:
image

HTML generado con el plugin:
image

Sin embargo, podria en la plantilla crearse una tabla de contenido si se quisiera porque el plugin tambien expone la propiedad .toc:

image

Esta propiedad permitiría incluir una tabla de contenido. Pero el objetivo es que permita citar con mayor precisión otros articulos en la pagina. Links del tipo: https://deploy-preview-422--vigilant-neumann-d109b9.netlify.app/blog/contribuir-blog-python-barranquilla/#creacion-de-entrada-en-lektor

Esta necesidad la descubrí al intentar citar una parte de un articulo del blog.

@Scot3004
Copy link
Member

Y por eso mencioné los enlaces estilo GitHub o una tabla de contenido, sino nadie va a saber de estos enlaces

@andoresuperesu
Copy link
Collaborator Author

andoresuperesu commented Jul 24, 2023

El PR se trata solo de agregar el plugin, no tiene ningún otro alcance más allá de habilitar el atributo id con el correspondiente slug. Dentro del repositorio del plugin hay un PR que busca añadir esa funcionalidad al mismo, pero está fuera de los alcances. A menos que se quiera agregar al repositorio como un paquete .

@pyjavo
Copy link
Member

pyjavo commented Jul 24, 2023

@andresperezcera ¡Super! Entonces por cada artículo que queramos, colocamos la tabla o agregamos eso un archivo "base" y que todos los artículos tengan esa tabla

@Scot3004 podriamos agregar la tabla de contenido algunos artículos para probar.
Aún no entiendo a que te refieres con enlaces estilo github 😅

@Scot3004
Copy link
Member

image
me refiero a cuando colocas el mouse sobre un titulo te aparece un botón para copiar el enlace

@andoresuperesu
Copy link
Collaborator Author

@pyjavo Yo sería partidario de agregar un campo booleano al modelo que se llame TOC o TDC y que cada quien marque si lo quiere agregar o no. También creería que este PR es super sencillo y mejor si se mantiene así. Puedo crear otro issue citando esta conversación en el que sea mas explicito.
En este issue:

  • Activar el plugin

Nuevo Issue:

  • Modificar modelo de BlogPost agregando nuevo campo booleano de TDC (Tabla de Contenido).
  • Agregar una TDC a la plantilla usando el ejemplo mostrado en este link
  • Crear maqueta de articulo con TDC.
  • Modificar plantilla de articulo de blog para incluir TDC opcional.
  • Crear CSS de TDC para artículos del Blog

La condición que tu mencionas @Scot3004 no es parte de este plugin, quizá podría darse con JavaScript. Pero si se menciona en el PR #12, para lograrla tendria que agregarse el plugin como un paquete ¿Quieres que lo intente?

@pyjavo
Copy link
Member

pyjavo commented Jul 25, 2023

Ok. De acuerdo 👍
Vayamos paso a paso (issue por issue)

@andoresuperesu
Copy link
Collaborator Author

@pyjavo @Scot3004 La pregunta es:
Aceptan el PR como está o quieren que se intente agregar como paquete el plugin con el PR#13 de ese repo que incluye links del tipo github? Es para saber si hay alguna tarea que agregar al #422.

Si se acepta como está, no se podrían agregar links tipo GitHub, sino que sería un PR aparte.

En cualquier caso tendria que haber otro issue que se trate de la implementación de TDC usando la propiedad .toc.

@Scot3004
Copy link
Member

Así está bien

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants