Custom Pages
You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js
files to the website/pages
directory. These files are React components and the render()
is called to create them, backed by CSS classes, etc.
Personalizar tu página de inicio
The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.
You can start your local server and go to http://localhost:3000
to see what the example home page looks like. A partir de ahí, edite el archivo website/pages/en/index.js
y sus diversos componentes para usar las imágenes y el texto que desee para su proyecto.
Agregar otras páginas personalizadas
Docusaurus provides some simple example pages in the website/pages/en
directory, including index.js
, users.js
, and help.js
. These are good examples to showcase how to create a custom page for Docusaurus.
root-directory
├── docs
└── website
├── blog
├── core
│ └── Footer.js
├── package.json
├── pages
│ ├── index.js
│ ├── users.js
│ └── help.js
├── sidebars.json
├── siteConfig.js
└── static
Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Puede encontrar más información sobre cómo usar los componentes proporcionados o incluir la suya propia aquí . La información sobre cómo enlazar a sus diferentes páginas en la barra de navegación del encabezado se puede encontrar aquí .
If you want your page to show up in your navigation header, you will need to update
siteConfig.js
to add to theheaderLinks
element. e.g.,{ page: 'about-slash', label: 'About/' }
,
Agregar páginas estáticas
Static .html
files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static
directory in the same way as other static assets. Alternatively, they can be placed in the pages
directory and would be served as-is instead of being rendered from React.
If you wish to use Docusaurus' stylesheet, you can access it at ${baseUrl}css/main.css
. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the siteConfig.separateCss
field in siteConfig.js
.
You can set the
$wrapPagesHTML
site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.
Personalizar tu página de inicio
Starting from the example core/Footer.js
file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.
El ejemplo proporcionado tiene tres columnas con una imagen de pie de página a la izquierda y el logotipo de fuente abierta de Facebook y derechos de autor en la parte inferior. Si su proyecto no es un proyecto de código abierto de Facebook, elimine el logotipo y los derechos de autor. De lo contrario, ¡siéntete libre de ser creativo con tu pie de página y ¡haz que se vea como quieras!
Algunas sugerencias de enlaces que puede proporcionar: documentación, API, Twitter, Discordia, grupos de Facebook, Stack Overflow, GitHub, etc.
Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.
If you do not want a footer for your site, change the render
function of core/Footer.js
to return null
. e.g.,
const React = require('react');
class Footer extends React.Component {
render() {
return null;
}
}
module.exports = Footer;