Inicio rápido

Esto lo lleva de una carpeta vacía a un sitio servido en pocos minutos.

1. Crear una carpeta de documentación

plasmoid lee un árbol de documentos cuya raíz contiene un archivo de configuración plasmoid.toml y un directorio por cada locale:

docs/
  plasmoid.toml
  en/
    index.md

Un plasmoid.toml mínimo es solo un título:

[site]
title = "My Project"

Todo lo demás tiene un valor por defecto razonable. El esquema completo está en la referencia de configuración.

2. Escribir una página de inicio

en/index.md con la plantilla home se convierte en la página de inicio del sitio:

---
template: home
title: My Project
tagline: A short, punchy description.
cta: { text: "Read the docs", href: "getting-started/intro" }
---

# Welcome

Some introductory prose rendered below the hero.

Consulte La página de inicio para conocer todos los campos del hero.

3. Añadir una página

Cree en/getting-started/intro.md:

---
title: Introduction
---

# Introduction

Your first real page. Folders become sidebar sections automatically.

Cómo las carpetas y los archivos se convierten en navegación se trata en Navegación.

4. Previsualizarlo

plasmoid serve --docs ./docs --watch

Esto compila el sitio, lo sirve en http://localhost:8080 y lo recompila en cada cambio. Abra la URL y verá su página de inicio, la barra lateral, el conmutador de modo oscuro y la búsqueda.

5. Compilar para producción

plasmoid build --docs ./docs --site ./public

./public contiene ahora el sitio estático completo. Despliegue ese directorio en cualquier lugar: la sección Despliegue muestra la receta de nginx.

Siguiente: compile el mismo sitio paso a paso en Su primera compilación.