diff --git a/CREDITS.md b/CREDITS.md index 3a2ed65e..ad0d9971 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,21 +1,21 @@ # 馃攦 Dependencias -PageTop est谩 basado en [Rust](https://www.rust-lang.org/) y crece a hombros de gigantes aprovechando -algunas de las librer铆as (*crates*) m谩s robustas y populares del [ecosistema Rust](https://lib.rs), -incluyendo: +`PageTop` est谩 basado en [Rust](https://www.rust-lang.org/) y crece a hombros de gigantes +aprovechando algunas de las librer铆as (*crates*) m谩s robustas y populares del +[ecosistema Rust](https://lib.rs), incluyendo: * [Actix Web](https://actix.rs/) para los servicios web. - * [Tracing](https://github.com/tokio-rs/tracing) para el seguimiento de los mensajes de registro y - diagn贸stico. + * [Tracing](https://github.com/tokio-rs/tracing) para la gesti贸n de trazas y registro de eventos + de la aplicaci贸n. * [Fluent templates](https://github.com/XAMPPRocky/fluent-templates), que integra [Fluent](https://projectfluent.org/) para internacionalizar las aplicaciones. - * Adem谩s de otros crates adicionales que puedes explorar en los archivos `Cargo.toml` de PageTop y - sus paquetes. + * Adem谩s de otros crates adicionales que puedes explorar en los archivos `Cargo.toml` de `PageTop` + y sus paquetes. # 鈱笍 C贸digo -PageTop incorpora c贸digo de [config-rs](https://crates.io/crates/config) (versi贸n +`PageTop` incorpora c贸digo de [config-rs](https://crates.io/crates/config) (versi贸n [0.11.0](https://github.com/mehcode/config-rs/tree/0.11.0)) de [Ryan Leckey](https://crates.io/users/mehcode), por sus ventajas para leer y asignar a tipos seguros las opciones de configuraci贸n, delegando la asignaci贸n a cada dise帽o, paquete o aplicaci贸n. @@ -23,9 +23,9 @@ las opciones de configuraci贸n, delegando la asignaci贸n a cada dise帽o, paquete # 馃棜 FIGfonts -PageTop usa el paquete [figlet-rs](https://crates.io/crates/figlet-rs) desarrollado por *yuanbohan* -para mostrar un banner de presentaci贸n en el terminal con el nombre de la aplicaci贸n en caracteres -[FIGlet](http://www.figlet.org). Las fuentes incluidas en `pagetop/src/app` son: +`PageTop` usa el paquete [figlet-rs](https://crates.io/crates/figlet-rs) desarrollado por +*yuanbohan* para mostrar un banner de presentaci贸n en el terminal con el nombre de la aplicaci贸n en +caracteres [FIGlet](http://www.figlet.org). Las fuentes incluidas en `pagetop/src/app` son: * [slant.flf](http://www.figlet.org/fontdb_example.cgi?font=slant.flf) de *Glenn Chappell* * [small.flf](http://www.figlet.org/fontdb_example.cgi?font=small.flf) de *Glenn Chappell* diff --git a/README.md b/README.md index c4ce5922..f8b71fc6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ -**PageTop** reivindica la sencillez de la web cl谩sica utilizando SSR (*renderizado en el servidor*), +`PageTop` reivindica la sencillez de la web cl谩sica utilizando SSR (*renderizado en el servidor*), HTML, CSS y JavaScript. Proporciona un conjunto completo de funcionalidades que pueden extenderse y adaptarse a las necesidades de cada soluci贸n web implementando: @@ -25,14 +25,14 @@ adaptarse a las necesidades de cada soluci贸n web implementando: * **Dise帽os** (*layouts*). Permiten a los desarrolladores modificar la apariencia de p谩ginas y componentes sin afectar a su funcionalidad. * **Paquetes** (*packages*). Extienden o personalizan funcionalidades existentes interactuando con - las APIs de PageTop o de paquetes de terceros. + las APIs de `PageTop` o de paquetes de terceros. # 鈿★笍 Inicio r谩pido -La aplicaci贸n m谩s sencilla de PageTop se ve as铆: +La aplicaci贸n m谩s sencilla de `PageTop` se ve as铆: -```rust +```rust#ignore use pagetop::prelude::*; #[pagetop::main] @@ -42,9 +42,9 @@ async fn main() -> std::io::Result<()> { ``` Proporciona una p谩gina de bienvenida en `http://localhost:8088` seg煤n la configuraci贸n predefinida. -Para personalizar el servicio puedes crear un paquete de PageTop: +Para personalizar el servicio puedes crear un paquete de `PageTop`: -```rust +```rust#ignore use pagetop::prelude::*; struct HelloWorld; @@ -84,27 +84,27 @@ El repositorio se organiza en un *workspace* con los siguientes subproyectos: * **[pagetop-build](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-build)**, permite incluir f谩cilmente archivos est谩ticos o archivos SCSS compilados directamente en el - binario de las aplicaciones **PageTop**. + binario de las aplicaciones `PageTop`. * **[pagetop-macros](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-macros)**, - proporciona una colecci贸n de macros que mejoran la experiencia de desarrollo con **PageTop**. + proporciona una colecci贸n de macros que mejoran la experiencia de desarrollo con `PageTop`. ## Paquetes * **[pagetop-seaorm](https://github.com/manuelcillero/pagetop/tree/latest/packages/pagetop-seaorm)**, integra [SeaORM](https://www.sea-ql.org/SeaORM) para trabajar con bases de datos en aplicaciones - **PageTop**. + `PageTop`. ## Aplicaci贸n * **[drust](https://github.com/manuelcillero/pagetop/tree/latest/drust)**, es una aplicaci贸n que - utiliza **PageTop** para crear un Sistema de Gesti贸n de Contenidos (CMS) que permita construir + utiliza `PageTop` para crear un Sistema de Gesti贸n de Contenidos (CMS) que permita construir sitios web din谩micos, administrados y configurables. # 馃毀 Advertencia -**PageTop** es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es +`PageTop` es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es inestable y est谩 sujeta a cambios frecuentes. No recomiendo su uso en producci贸n, al menos mientras no se libere una versi贸n **1.0.0**. diff --git a/drust/README.md b/drust/README.md index 84030750..61ae89d1 100644 --- a/drust/README.md +++ b/drust/README.md @@ -10,7 +10,7 @@ -Modestamente inspirado en [Drupal](https://www.drupal.org), **Drust** exprime **PageTop** para +Modestamente inspirado en [Drupal](https://www.drupal.org), `Drust` exprime `PageTop` para desarrollar un *Sistema de Gesti贸n de Contenidos* (CMS) b谩sico, que permita construir sitios web din谩micos, manejables y personalizables; y facilite a los usuarios la gesti贸n de una variedad de contenidos de manera sencilla. @@ -24,7 +24,7 @@ sencillez de la web cl谩sica aplicando *renderizado en el servidor* (SSR), HTML, # 馃毀 Advertencia -**PageTop** es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es +`PageTop` es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es inestable y est谩 sujeta a cambios frecuentes. No recomiendo su uso en producci贸n, al menos mientras no se libere una versi贸n **1.0.0**. diff --git a/helpers/pagetop-build/README.md b/helpers/pagetop-build/README.md index abb9fa98..2afda877 100644 --- a/helpers/pagetop-build/README.md +++ b/helpers/pagetop-build/README.md @@ -19,7 +19,7 @@ sencillez de la web cl谩sica aplicando *renderizado en el servidor* (SSR), HTML, # 馃毀 Advertencia -**PageTop** es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es +`PageTop` es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es inestable y est谩 sujeta a cambios frecuentes. No recomiendo su uso en producci贸n, al menos mientras no se libere una versi贸n **1.0.0**. diff --git a/helpers/pagetop-build/src/lib.rs b/helpers/pagetop-build/src/lib.rs index fa4a9249..51d39abb 100644 --- a/helpers/pagetop-build/src/lib.rs +++ b/helpers/pagetop-build/src/lib.rs @@ -1,5 +1,5 @@ //! Incluye f谩cilmente archivos est谩ticos o archivos SCSS compilados directamente en el binario de -//! tus aplicaciones **PageTop**. +//! tus aplicaciones `PageTop``. //! //! # A帽adir al proyecto //! @@ -11,7 +11,7 @@ //! ``` //! //! Crea luego un archivo `build.rs` para definir c贸mo se van a incluir los archivos est谩ticos o -//! archivos SCSS en tu aplicaci贸n, dise帽o o paquete de PageTop. Ejemplos de uso: +//! archivos SCSS en tu aplicaci贸n, dise帽o o paquete de `PageTop`. Ejemplos de uso: //! //! ## 1. Incluir archivos est谩ticos desde un directorio //! diff --git a/helpers/pagetop-macros/README.md b/helpers/pagetop-macros/README.md index 322d8f38..99275ba8 100644 --- a/helpers/pagetop-macros/README.md +++ b/helpers/pagetop-macros/README.md @@ -17,7 +17,7 @@ Entre sus macros se incluye una adaptaci贸n de [maud-macros](https://crates.io/c [SmartDefault](https://crates.io/crates/smart_default) (0.7.1) de [Jane Doe](https://crates.io/users/jane-doe), llamada `AutoDefault`. Estas macros eliminan la necesidad de referenciar `maud` o `smart_default` en las dependencias del archivo `Cargo.toml` de -cada proyecto **PageTop**. +cada proyecto `PageTop`. # 馃摝 Sobre PageTop @@ -28,7 +28,7 @@ sencillez de la web cl谩sica aplicando *renderizado en el servidor* (SSR), HTML, # 馃毀 Advertencia -**PageTop** es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es +`PageTop` es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Su API es inestable y est谩 sujeta a cambios frecuentes. No recomiendo su uso en producci贸n, al menos mientras no se libere una versi贸n **1.0.0**. diff --git a/helpers/pagetop-macros/src/lib.rs b/helpers/pagetop-macros/src/lib.rs index 9cc0c3a2..ab94ea1a 100644 --- a/helpers/pagetop-macros/src/lib.rs +++ b/helpers/pagetop-macros/src/lib.rs @@ -1,4 +1,4 @@ -//! Una colecci贸n de macros que impulsan el desarrollo con **PageTop**. +//! Una colecci贸n de macros que impulsan el desarrollo con `PageTop`. mod maud; mod smart_default; diff --git a/packages/pagetop-seaorm/README.md b/packages/pagetop-seaorm/README.md index be30540f..c5223e31 100644 --- a/packages/pagetop-seaorm/README.md +++ b/packages/pagetop-seaorm/README.md @@ -11,8 +11,8 @@ -PageTop SeaORM utiliza [SQLx](https://crates.io/crates/sqlx) y -[SeaQuery](https://crates.io/crates/sea-query), adem谩s de integrar en c贸digo una versi贸n adaptada de +Utiliza [SQLx](https://crates.io/crates/sqlx) y [SeaQuery](https://crates.io/crates/sea-query) para +exportar sus funcionalidades, y tambi茅n integra en c贸digo una versi贸n adaptada de [SeaORM Migration](https://github.com/SeaQL/sea-orm/tree/1.1.1/sea-orm-migration/src) (v1.1.1) para permitir migraciones independientes para cada paquete del proyecto. @@ -25,7 +25,7 @@ sencillez de la web cl谩sica aplicando *renderizado en el servidor* (SSR), HTML, # 馃毀 Advertencia -**PageTop** es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Est谩 en +`PageTop` es un proyecto personal que hago por diversi贸n para aprender cosas nuevas. Est谩 en desarrollo activo, su API es inestable y est谩 sujeta a cambios frecuentes. No recomiendo su uso en producci贸n, al menos hasta liberar la versi贸n **1.0.0**. diff --git a/packages/pagetop-seaorm/src/config.rs b/packages/pagetop-seaorm/src/config.rs index f423cb7e..4d9b3a74 100644 --- a/packages/pagetop-seaorm/src/config.rs +++ b/packages/pagetop-seaorm/src/config.rs @@ -20,7 +20,7 @@ //! //! assert_eq!(config::SETTINGS.database.db_host, "localhost"); //! ``` -//! See [`pagetop::include_config`] to learn how **PageTop** read configuration files and use +//! See [`pagetop::include_config`] to learn how `PageTop` read configuration files and use //! settings. use pagetop::prelude::*; diff --git a/pagetop/src/app.rs b/pagetop/src/app.rs index 7c5b8930..da2f67f6 100644 --- a/pagetop/src/app.rs +++ b/pagetop/src/app.rs @@ -1,4 +1,4 @@ -//! Prepare and run an application created with **Pagetop**. +//! Prepara y ejecuta una aplicaci贸n creada con `Pagetop`. mod figfont; diff --git a/pagetop/src/base.rs b/pagetop/src/base.rs index b3258dc2..e262d56d 100644 --- a/pagetop/src/base.rs +++ b/pagetop/src/base.rs @@ -1,4 +1,4 @@ -//! Base actions, components, layouts, and packages. +//! Acciones, componentes, dise帽os y paquetes base de `PageTop`. pub mod action; diff --git a/pagetop/src/config.rs b/pagetop/src/config.rs index 3db091db..cd874295 100644 --- a/pagetop/src/config.rs +++ b/pagetop/src/config.rs @@ -1,4 +1,4 @@ -//! Load configuration settings. +//! Carga los ajustes de configuraci贸n. //! //! These settings are loaded from [TOML](https://toml.io) files as `key = value` pairs and mapped //! into type-safe structures with predefined values. diff --git a/pagetop/src/core.rs b/pagetop/src/core.rs index f7a47bd0..3c05417a 100644 --- a/pagetop/src/core.rs +++ b/pagetop/src/core.rs @@ -1,4 +1,4 @@ -//! Key types and functions for creating actions, components, layouts, and packages. +//! Tipos y funciones esenciales para crear acciones, componentes, dise帽os y paquetes. use crate::util::TypeInfo; diff --git a/pagetop/src/datetime.rs b/pagetop/src/datetime.rs index 732431df..a726f29d 100644 --- a/pagetop/src/datetime.rs +++ b/pagetop/src/datetime.rs @@ -1,4 +1,4 @@ -//! [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time handling +//! Soporte a fechas y horas seg煤n est谩ndar [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) //! ([chrono](https://docs.rs/chrono)). pub use chrono::prelude::*; diff --git a/pagetop/src/global.rs b/pagetop/src/global.rs index 970d9687..4c8fed28 100644 --- a/pagetop/src/global.rs +++ b/pagetop/src/global.rs @@ -1,4 +1,4 @@ -//! Global settings. +//! Ajustes globales de `PageTop`. use crate::include_config; diff --git a/pagetop/src/html.rs b/pagetop/src/html.rs index 939316b7..3cc2637e 100644 --- a/pagetop/src/html.rs +++ b/pagetop/src/html.rs @@ -1,4 +1,4 @@ -//! HTML in code. +//! HTML en c贸digo. mod maud; pub use maud::{html, html_private, Markup, PreEscaped, DOCTYPE}; diff --git a/pagetop/src/lib.rs b/pagetop/src/lib.rs index 664bd7a5..c228dcfc 100644 --- a/pagetop/src/lib.rs +++ b/pagetop/src/lib.rs @@ -4,30 +4,45 @@ //! //!
An opinionated web framework to build modular Server-Side Rendering web solutions.
+//!Entorno de desarrollo para crear soluciones web modulares, extensibles y configurables.
//! -//! [](https://github.com/manuelcillero/pagetop#-license) -//! [](https://docs.rs/pagetop) +//! [](#-license) +//! [](https://docs.rs/pagetop) //! [](https://crates.io/crates/pagetop) -//! [](https://crates.io/crates/pagetop) +//! [](https://crates.io/crates/pagetop) //! //!