Creating your site · Docusaurus

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

Después de instalación y preparación, gran parte del trabajo para crear un sitio básico para tus documentos ya está completo.

Estructura del sitio

Your site structure looks like the following:

root-directory
├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

This assumes that you removed the example .md files that were installed with the initialization script.

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

Crea tu sitio básico

Para crear un sitio totalmente funcional, solo necesita hacer unos pocos pasos:

Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
```
---
id: intro
title: Getting Started
---

My new content here..
```
Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

Si no agrega su documentación al archivo sidebars.json, los documentos se mostrarán, pero solo se pueden vincular desde otra documentación y se pueden visitar con la URL conocida.

Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
Place assets, such as images, in the website/static/ directory.
Ejecute el sitio para ver los resultados de sus cambios.

cd website
yarn run start # or `npm run start`
# Navigate to http://localhost:3000

Special Customization

Docs Landing Page

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

Remove the index.js file from the website/pages directory, if it exists.
Add a custom static index.html page in the website/static directory with the following contents:

<!DOCTYPE HTML>
<html lang="en-US">
  <head>
    <meta charset="UTF-8">
    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
    <script type="text/javascript">
      window.location.href = 'docs/id-of-doc-to-land-on.html';
    </script>
    <title>Your Site Title Here</title>
  </head>
  <body>
    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
  </body>
</html>

You will get the id of the document to land on the .md metadata of that doc page.

Blog Only

You can also use Docusaurus to host your blog only.