How to add HTML extension

Abierto
#777 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
html, react, typescript

Línea de trabajo

Start with the linked HTML-block extension documentation and reproduce its demo using YfmStaticView. Read src/extensions/additional/index.ts to verify whether yfmHtmlBlock is exported, and inspect the shown HtmlRenderer example for the missing useMemo syntax and configuration. Done means the documentation contains an executable example with the correct imports, hook usage, and extension export guidance, and the demo runs without reported errors.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

"@gravity-ui/markdown-editor": "^15.11.0"
In hte doc How to add HTML extension: https://preview.gravity-ui.com/md-editor/?path=/docs/docs-extensions-html-block--docs, The code inside cannot be executed and all errors are reported,please update this doc demo,tell me How to integrate YFM HTML block extension?

For example

// render
const HtmlRenderer = React.forwardRef<HTMLDivElement, HtmlRendererProps>((props, ref) => {
  // ...
  const theme = useThemeType(); // your hook for get theme

  const yfmHtmlBlockConfig = useYfmHtmlBlockStyles();
    () => ({
      theme,
      zoom: {showMenu: true, bindKeys: true, resetOnBlur: true},
    }),
    [theme],
  );

  // ...
  return (
    <div>
      <YfmStaticView
        html={html}
        meta={meta}
        ref={elementRef}
        yfmHtmlBlockConfig={yfmHtmlBlockConfig}
      />
      {props.children}
    </div>
  );
});

() => ({
theme,
zoom: {showMenu: true, bindKeys: true, resetOnBlur: true},
}),
[theme],
);
what this in the react component?

  1. markdown-editor/src/extensions/additional//index.ts
    only export GPT
    export * from './GPT';
    not export yfmHtmlBlock
Lenguaje dominante
TypeScript
Estrellas
428
Forks
48
Merge medio
5 d 15 h
PR fusionados (30 d)
47

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de gravity-ui/markdown-editor

Todos los issues de gravity-ui/markdown-editor

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.