From 388ff26764d8946e53df04e90e8db7e0c6dfa302 Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Sat, 23 Mar 2024 12:39:21 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Condense=20and=20unify=20PageTop?= =?UTF-8?q?=20description?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Cargo.toml | 3 +-- README.md | 32 +++++++++++++++++++---------- helpers/pagetop-build/README.md | 4 ++-- helpers/pagetop-macros/README.md | 4 ++-- packages/pagetop-admin/README.md | 4 ++-- packages/pagetop-bootsier/README.md | 4 ++-- packages/pagetop-bulmix/README.md | 4 ++-- packages/pagetop-node/README.md | 4 ++-- packages/pagetop-user/README.md | 4 ++-- src/lib.rs | 20 +++++++++--------- 10 files changed, 46 insertions(+), 37 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 15746da3..a99b3fd3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,8 +7,7 @@ authors = [ "Manuel Cillero " ] description = """\ - PageTop is an opinionated Rust web development framework to build secure and modular \ - Server-Side Rendering (SSR) web solutions. + An opinionated web framework to build modular Server-Side Rendering web solutions. """ homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" diff --git a/README.md b/README.md index fd11ad17..ff9b7f22 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,27 @@

PageTop

+

An opinionated web framework to build modular Server-Side Rendering web solutions.

+ [![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) [![API Docs](https://img.shields.io/docsrs/pagetop?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop) [![Crates.io](https://img.shields.io/crates/v/pagetop.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop) [![Downloads](https://img.shields.io/crates/d/pagetop.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop) +
-**PageTop** is an opinionated [Rust](https://www.rust-lang.org) web development framework to build -secure and modular Server-Side Rendering (SSR) web solutions. +The PageTop core API provides a comprehensive toolkit for extending its functionalities to specific +requirements and application scenarios through actions, components, packages, and themes: -PageTop stands on the shoulders of giants. It leverages some of the most stable and popular Rust -crates to provide extensible and easily configurable features. - -# 🚧 Warning - -**PageTop** framework is currently in active development. The API is unstable and subject to -frequent changes. Production use is not recommended until version **0.1.0**. +* **Actions** serve as a mechanism to customize PageTop's internal behavior by intercepting its + execution flow. +* **Components** encapsulate HTML, CSS, and JavaScript into functional, configurable, and + well-defined units. +* **Packages** extend or customize existing functionality by interacting with PageTop APIs or + third-party package APIs. +* **Themes** enable developers to alter the appearance of pages and components without affecting + their functionality. # ⚡️ Quick start @@ -61,8 +65,8 @@ distinct role within the PageTop ecosystem: * [drust](https://github.com/manuelcillero/pagetop/tree/main/drust): A simple Content Management System (CMS) built on PageTop, which enables the creation, editing, - and maintenance of dynamic, fast, and secure websites. It uses the following essential packages to - provide standard CMS functionalities. + and maintenance of dynamic, fast, and modular websites. It uses the following essential packages + to provide standard CMS functionalities. ## Helpers @@ -94,6 +98,12 @@ distinct role within the PageTop ecosystem: Utilizes the *[Bulma](https://bulma.io/)* framework for sleek, responsive design elements. +# 🚧 Warning + +**PageTop** framework is currently in active development. The API is unstable and subject to +frequent changes. Production use is not recommended until version **0.1.0**. + + # 📜 License PageTop is free, open source and permissively licensed! Except where noted (below and/or in diff --git a/helpers/pagetop-build/README.md b/helpers/pagetop-build/README.md index 89e10d3f..2aa67df0 100644 --- a/helpers/pagetop-build/README.md +++ b/helpers/pagetop-build/README.md @@ -4,8 +4,8 @@ applications. # 📦 About PageTop -[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web -development framework to build secure and modular Server-Side Rendering (SSR) web solutions. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. # 🚧 Warning diff --git a/helpers/pagetop-macros/README.md b/helpers/pagetop-macros/README.md index f22754b7..d6879110 100644 --- a/helpers/pagetop-macros/README.md +++ b/helpers/pagetop-macros/README.md @@ -3,8 +3,8 @@ A collection of procedural macros that enhance the development experience within # 📦 About PageTop -[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web -development framework to build secure and modular Server-Side Rendering (SSR) web solutions. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. # 🚧 Warning diff --git a/packages/pagetop-admin/README.md b/packages/pagetop-admin/README.md index 1f5441ad..2815c5e0 100644 --- a/packages/pagetop-admin/README.md +++ b/packages/pagetop-admin/README.md @@ -4,8 +4,8 @@ package settings. # 📦 About PageTop -[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web -development framework to build secure and modular Server-Side Rendering (SSR) web solutions. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. # 🚧 Warning diff --git a/packages/pagetop-bootsier/README.md b/packages/pagetop-bootsier/README.md index 92efa382..31d9a6fe 100644 --- a/packages/pagetop-bootsier/README.md +++ b/packages/pagetop-bootsier/README.md @@ -4,8 +4,8 @@ versatile page layouts and component stylings. # 📦 About PageTop -[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web -development framework to build secure and modular Server-Side Rendering (SSR) web solutions. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. # 🚧 Warning diff --git a/packages/pagetop-bulmix/README.md b/packages/pagetop-bulmix/README.md index 786762dc..1b365354 100644 --- a/packages/pagetop-bulmix/README.md +++ b/packages/pagetop-bulmix/README.md @@ -4,8 +4,8 @@ design elements. # 📦 About PageTop -[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web -development framework to build secure and modular Server-Side Rendering (SSR) web solutions. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. # 🚧 Warning diff --git a/packages/pagetop-node/README.md b/packages/pagetop-node/README.md index ac233849..789a8498 100644 --- a/packages/pagetop-node/README.md +++ b/packages/pagetop-node/README.md @@ -4,8 +4,8 @@ content management. # 📦 About PageTop -[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web -development framework to build secure and modular Server-Side Rendering (SSR) web solutions. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. # 🚧 Warning diff --git a/packages/pagetop-user/README.md b/packages/pagetop-user/README.md index 6af871a5..637741fd 100644 --- a/packages/pagetop-user/README.md +++ b/packages/pagetop-user/README.md @@ -4,8 +4,8 @@ built on **PageTop**. # 📦 About PageTop -[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web -development framework to build secure and modular Server-Side Rendering (SSR) web solutions. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. # 🚧 Warning diff --git a/src/lib.rs b/src/lib.rs index 3a670ee7..12361d2b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,19 +1,19 @@ //!
//! -//! +//! //! -//!

PageTop

+//!

PageTop

//! -//! [![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](https://github.com/manuelcillero/pagetop#-license) -//! [![API Docs](https://img.shields.io/docsrs/pagetop?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop) -//! [![Crates.io](https://img.shields.io/crates/v/pagetop.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop) -//! [![Downloads](https://img.shields.io/crates/d/pagetop.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop) +//!

An opinionated web framework to build modular Server-Side Rendering web solutions.

//! +//! [![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](https://github.com/manuelcillero/pagetop#-license) +//! [![API Docs](https://img.shields.io/docsrs/pagetop?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop) +//! [![Crates.io](https://img.shields.io/crates/v/pagetop.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop) +//! [![Downloads](https://img.shields.io/crates/d/pagetop.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop) +//! +//!
//!
//! -//! **PageTop** is an opinionated Rust web development framework to build modular Server-Side -//! Rendering (SSR) web solutions. -//! //! The PageTop core API provides a comprehensive toolkit for extending its functionalities to //! specific requirements and application scenarios through actions, components, packages, and //! themes: @@ -54,7 +54,7 @@ //! This program implements a package named `HelloWorld` with one service that returns a web page //! that greets the world whenever it is accessed from the browser at `http://localhost:8088` (using //! the [default configuration settings](`config::Server`)). You can find this code in the PageTop -//! [basic examples repository](https://github.com/manuelcillero/pagetop/tree/main/examples/basics). +//! [examples repository](https://github.com/manuelcillero/pagetop/tree/main/examples). //! //! # 🧩 Dependency Management //!