📝 Limpia y corrige documentación de extensiones
This commit is contained in:
parent
f9e87058d8
commit
41c4379bc3
14 changed files with 50 additions and 104 deletions
|
|
@ -11,14 +11,13 @@
|
|||
|
||||
</div>
|
||||
|
||||
## 🧭 Sobre PageTop
|
||||
## Sobre PageTop
|
||||
|
||||
[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
|
||||
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
||||
configurables, basadas en HTML, CSS y JavaScript.
|
||||
|
||||
|
||||
## ⚡️ Guía rápida
|
||||
## Guía rápida
|
||||
|
||||
Añadir en el archivo `Cargo.toml` del proyecto:
|
||||
|
||||
|
|
@ -82,8 +81,7 @@ fn main() -> std::io::Result<()> {
|
|||
Este código compila el archivo `main.scss` de la carpeta `static` del proyecto, y prepara un recurso
|
||||
llamado `main_styles` que contiene el archivo `styles.min.css` obtenido.
|
||||
|
||||
|
||||
## 📦 Archivos generados
|
||||
## Archivos generados
|
||||
|
||||
Cada conjunto de recursos [`StaticFilesBundle`] genera un archivo en el directorio estándar
|
||||
[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts)
|
||||
|
|
@ -103,22 +101,21 @@ use pagetop::prelude::*;
|
|||
pub struct MyExtension;
|
||||
|
||||
impl Extension for MyExtension {
|
||||
// Servicio web que publica los recursos de `guides` en `/ruta/a/guides`.
|
||||
fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||
serve_static_files!(scfg, guides => "/ruta/a/guides");
|
||||
/// Registra los recursos de `guides` en el router bajo `/ruta/a/guides`.
|
||||
fn configure_router(&self, mut router: Router) -> Router {
|
||||
serve_static_files!(router, [guides] => "/ruta/a/guides");
|
||||
router
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## 🚧 Advertencia
|
||||
## Advertencia
|
||||
|
||||
**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
||||
ecosistema. Su API está sujeta a cambios frecuentes. No se recomienda su uso en producción, al menos
|
||||
hasta que se libere la versión **1.0.0**.
|
||||
|
||||
|
||||
## 📜 Licencia
|
||||
## Licencia
|
||||
|
||||
El código está disponible bajo una doble licencia:
|
||||
|
||||
|
|
|
|||
|
|
@ -18,8 +18,7 @@
|
|||
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
||||
configurables, basadas en HTML, CSS y JavaScript.
|
||||
|
||||
|
||||
# ⚡️ Guía rápida
|
||||
## Guía rápida
|
||||
|
||||
Añadir en el archivo `Cargo.toml` del proyecto:
|
||||
|
||||
|
|
@ -31,7 +30,7 @@ pagetop-build = { ... }
|
|||
Y crear un archivo `build.rs` a la altura de `Cargo.toml` para indicar cómo se van a incluir los
|
||||
archivos estáticos o cómo se van a compilar los archivos SCSS para el proyecto. Casos de uso:
|
||||
|
||||
## Incluir archivos estáticos desde un directorio
|
||||
### Incluir archivos estáticos desde un directorio
|
||||
|
||||
Hay que preparar una carpeta en el proyecto con todos los archivos que se quieren incluir, por
|
||||
ejemplo `static`, y añadir el siguiente código en `build.rs` para crear el conjunto de recursos:
|
||||
|
|
@ -65,7 +64,7 @@ fn main() -> std::io::Result<()> {
|
|||
}
|
||||
```
|
||||
|
||||
## Compilar archivos SCSS a CSS
|
||||
### Compilar archivos SCSS a CSS
|
||||
|
||||
Se puede compilar un archivo SCSS, que podría importar otros a su vez, para preparar un recurso con
|
||||
el archivo CSS minificado obtenido. Por ejemplo:
|
||||
|
|
@ -83,8 +82,7 @@ fn main() -> std::io::Result<()> {
|
|||
Este código compila el archivo `main.scss` de la carpeta `static` del proyecto, y prepara un recurso
|
||||
llamado `main_styles` que contiene el archivo `styles.min.css` obtenido.
|
||||
|
||||
|
||||
# 📦 Archivos generados
|
||||
## Archivos generados
|
||||
|
||||
Cada conjunto de recursos [`StaticFilesBundle`] genera un archivo en el directorio estándar
|
||||
[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts)
|
||||
|
|
|
|||
|
|
@ -11,14 +11,13 @@
|
|||
|
||||
</div>
|
||||
|
||||
## 🧭 Sobre PageTop
|
||||
## Sobre PageTop
|
||||
|
||||
[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
|
||||
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
||||
configurables, basadas en HTML, CSS y JavaScript.
|
||||
|
||||
|
||||
## 📚 Créditos
|
||||
## Créditos
|
||||
|
||||
Este *crate* incluye entre sus macros una adaptación de
|
||||
[maud-macros](https://crates.io/crates/maud_macros)
|
||||
|
|
@ -29,15 +28,13 @@ Este *crate* incluye entre sus macros una adaptación de
|
|||
necesidad de referenciar `maud` o `smart_default` en las dependencias del archivo `Cargo.toml` de
|
||||
cada proyecto PageTop.
|
||||
|
||||
|
||||
## 🚧 Advertencia
|
||||
## Advertencia
|
||||
|
||||
**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
||||
ecosistema. Su API está sujeta a cambios frecuentes. No se recomienda su uso en producción, al menos
|
||||
hasta que se libere la versión **1.0.0**.
|
||||
|
||||
|
||||
## 📜 Licencia
|
||||
## Licencia
|
||||
|
||||
El código está disponible bajo una doble licencia:
|
||||
|
||||
|
|
|
|||
|
|
@ -11,21 +11,19 @@
|
|||
|
||||
</div>
|
||||
|
||||
## 🧭 Sobre PageTop
|
||||
## Sobre PageTop
|
||||
|
||||
[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
|
||||
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
||||
configurables, basadas en HTML, CSS y JavaScript.
|
||||
|
||||
|
||||
## 🗺️ Descripción general
|
||||
## Descripción general
|
||||
|
||||
Este *crate* proporciona un conjunto básico de macros que se integran en las utilidades de PageTop
|
||||
para optimizar operaciones habituales relacionadas con la composición estructurada de texto, la
|
||||
concatenación de cadenas y el uso rápido de colecciones clave-valor.
|
||||
|
||||
|
||||
## 📚 Créditos
|
||||
## Créditos
|
||||
|
||||
Las macros para texto multilínea **`indoc!`**, **`formatdoc!`** y **`concatdoc!`** se reexportan del
|
||||
*crate* [indoc](https://crates.io/crates/indoc) de [David Tolnay](https://crates.io/users/dtolnay).
|
||||
|
|
@ -39,15 +37,13 @@ La macro para generar identificadores dinámicos **`paste!`** se reexporta del *
|
|||
[pastey](https://crates.io/crates/pastey), una implementación avanzada y soportada del popular
|
||||
`paste!` de [David Tolnay](https://crates.io/users/dtolnay).
|
||||
|
||||
|
||||
## 🚧 Advertencia
|
||||
## Advertencia
|
||||
|
||||
**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
||||
ecosistema. Su API está sujeta a cambios frecuentes. No se recomienda su uso en producción, al menos
|
||||
hasta que se libere la versión **1.0.0**.
|
||||
|
||||
|
||||
## 📜 Licencia
|
||||
## Licencia
|
||||
|
||||
El código está disponible bajo una doble licencia:
|
||||
|
||||
|
|
|
|||
|
|
@ -31,15 +31,13 @@ Para ello, adapta el código de [static-files](https://crates.io/crates/static_f
|
|||
se integra en PageTop para evitar que cada proyecto tenga que declarar `static-files` manualmente
|
||||
como dependencia en su `Cargo.toml`.
|
||||
|
||||
|
||||
## 🚧 Advertencia
|
||||
## Advertencia
|
||||
|
||||
**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
||||
ecosistema. Su API está sujeta a cambios frecuentes. No se recomienda su uso en producción, al menos
|
||||
hasta que se libere la versión **1.0.0**.
|
||||
|
||||
|
||||
## 📜 Licencia
|
||||
## Licencia
|
||||
|
||||
El código está disponible bajo una doble licencia:
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ como dependencia en su `Cargo.toml`.
|
|||
|
||||
/// Resource definition and single module based generation.
|
||||
pub mod resource;
|
||||
|
||||
#[doc(inline)]
|
||||
pub use resource::Resource as StaticFile;
|
||||
|
||||
mod resource_dir;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue