¿Cómo cambiar el pie de página en DOCFX? -- docfx camp Relacionados El problema

How to change the footer in DocFX?


5
vote

problema

Español

Solo espero cambiar la información de los derechos de autor de pie de página, generada por DOCFX.

footer

aquí es lo que he hecho:

  1. Plantilla de exportación:

ejecutar docfx template export default , obtenga una carpeta _exported_templatesdefault

  1. Cambiar el pie de página parcials:

Los archivos que he cambiado son . parcials_footer.liquid y . parcials footer.tmpl.partial

  1. Utilice la plantilla actualizada:

ejecutar docfx -t _exported_templatesdefault .

  1. sirve al sitio otra vez

ejecutar docfx docfx.json --serve .

Pero la actualización no se muestra cuando actualizo la página de documentación. ¿Hay algo más que me haya perdido?

Original en ingles

Just hope to change the footer copyright info, generated by DocFX.

footer

Here is what I have done:

  1. Export template:

Run docfx template export default, get a folder _exported_templates\default

  1. Change the footer partials:

The files I have changed are .\partials_footer.liquid and .\partials\footer.tmpl.partial

  1. Use the updated template:

Run docfx -t _exported_templates\default.

  1. Serve the site again

Run docfx docfx.json --serve.

But the update is not shown when I refresh the documentation page. Is there anything else I have missed?

  

Lista de respuestas

10
 
vote

Intente fusionar el paso 3, 4 en: docfx -t _exported_templatesdefault --serve .

Explicación: Si abre la salida de compilación en _site después del Paso 3, debe encontrar el pie de página en realidad actualizado. En el Paso 4, DOCFX se recupera nuevamente el sitio antes de servir, así que finalmente encuentra el pie de página original porque esta compilación no usa su plantilla personalizada.

Otra solución rápida es agregar _appFooter a Metadatos globales en docfx.json Como:

  "globalMetadata": {   "_appFooter": "<span>Customized Footer</span>" },   

Lista de metadatos reservados completa se puede encontrar aquí: http : //dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html#322-reserved-metadata

 

Try merge step 3, 4 into: docfx -t _exported_templates\default --serve.

Explanation: If you open the build output in _site after step 3, you should find the footer is actually updated. In step 4, DocFX builds the site again before serving, so finally you find the original footer because this build doesn't use your customized template.

Another quick solution is to add _appFooter to global metadata in docfx.json like:

"globalMetadata": {   "_appFooter": "<span>Customized Footer</span>" }, 

Full reserved metadata list can be found here: http://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html#322-reserved-metadata

 
 
1
 
vote

La forma más fácil de hacer esto es cambiar el modelo directamente. En su plantilla, cree un archivo llamado conceptual.extension.js y use el siguiente código:

  exports.postTransform = function (model) {     model._appFooter = "<span>Copyright © 2015-2017 MY COPYRIGHT<br>Generated by <strong>DocFX</strong></span>";     return model; }   
 

The easiest way to do this is to change the model directly. In your template, create a file called conceptual.extension.js and use the following code:

exports.postTransform = function (model) {     model._appFooter = "<span>Copyright xc2xa9 2015-2017 MY COPYRIGHT<br>Generated by <strong>DocFX</strong></span>";     return model; } 
 
 

Relacionados problema

0  Resalte el elemento seleccionado en TOC: DOCFX  ( Highlight selected item in toc docfx ) 
Sistema operativo : Windows DOCFX versión usada : docfx.console.2.56.1 plantilla usada : default pasos para reproducir : Estoy tratando de mo...

6  Plantuml no representa el diagrama después de la construcción DOCFX  ( Plantuml does not render diagram after build docfx ) 
https://github.com/kevreed/docfx.plugins.plantuml < / p> He instalado Plantuml para el complemento DOCFX a través de NUDET. Por nuget install DocFx.Plugin...

1  Llamada de API simple dentro del contexto del preprocesador DOCFX  ( Simple api call within the context of docfx preprocessor ) 
Me gustaría saber si es posible hacer una simple llamada de API (por ejemplo, GitHub API V3) en el contexto de un preprocesador de plantillas personalizado DO...

4  Cómo crear un repositorio central de documentación de código de código usando DOCFX  ( How to create a searchable central repository of code documentation using docfx ) 
Estoy buscando crear un repositorio central para toda nuestra documentación de API publicada utilizando DOCFX. Tengo documentación generada automáticamente a ...

2  Referencia de API DOCFX - no se resuelve ver etiqueta  ( Docfx api reference does not resolve see tag ) 
Seguí este tutorial para crear una documentación de API para un Biblioteca de clases. En los comentarios de mi biblioteca de clases, la etiqueta para hac...

1  ¿Cómo agrupar los métodos por región o algún otro método de agrupación para la documentación?  ( How to group methods by region or some other grouping method for documentation ) 
Tengo una clase grande que expone muchos comandos. Cuando creo documentación para la clase, los métodos se clasifican alfabéticamente, pero me gustaría que ag...

0  Cambiar ancho de SidetoC  ( Change width of sidetoc ) 
Básicamente, estoy tratando de cambiar el ancho de la navegación en el lado izquierdo (SidetoC). Algunos de mis espacios de nombres y tipos son más anchos de ...

0  ¿Es posible generar documentación DOCFX de múltiples repositarios?  ( Is it possible to generate docfx documentation from multiple repositorys ) 
Tengo múltiples documentaciones de DOCFX en diferentes repositarios. ¿Cómo puedo fusionar esta documentación en un proyecto DOCFX que contiene otros otros? ...

1  xmldoc <ver> con el cref que se refiere a una clase bajo un CSPROJ separado  ( Xmldoc see with cref that refers to a class under a separate csproj ) 
Tenemos un proyecto SDK que incluye un motor de prueba. Estos viven bajo dos csproj diferentes. Así que tenemos SDK.csproj y TestEngine.csproj donde SDK....

5  La condición de paquetes se ignora  ( Packagereference condition is ignored ) 
En mi proyecto VS 2017, me referen el paquete DOCFX.Console y quiero que se use solo cuando se cumpla con cierta condición. Pero el paquete se usa para todas ...




© 2022 respuesta.top Reservados todos los derechos. Centro de preguntas y respuestas reservados todos los derechos