manuelcillero/pagetop
manuelcillero/pagetop
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

📝 Condense and unify PageTop description

Browse source
This commit is contained in:
Manuel Cillero 2024-03-23 12:39:21 +01:00
parent 366a3c1c74
commit 388ff26764
10 changed files with 46 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Cargo.toml
View file

@ -7,8 +7,7 @@ authors = [
"Manuel Cillero <manuel@cillero.es>" "Manuel Cillero <manuel@cillero.es>"
] ]
description = """\ description = """\
PageTop is an opinionated Rust web development framework to build secure and modular \ An opinionated web framework to build modular Server-Side Rendering web solutions.
Server-Side Rendering (SSR) web solutions.
""" """
homepage = "https://pagetop.cillero.es" homepage = "https://pagetop.cillero.es"
repository = "https://github.com/manuelcillero/pagetop" repository = "https://github.com/manuelcillero/pagetop"

32
README.md
View file

@ -4,23 +4,27 @@
<h1>PageTop</h1> <h1>PageTop</h1>
<p>An opinionated web framework to build modular <em>Server-Side Rendering</em> web solutions.</p>
[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) [![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) [![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) [![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) [![Downloads](https://img.shields.io/crates/d/pagetop.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop)
<br>
</div> </div>
**PageTop** is an opinionated [Rust](https://www.rust-lang.org) web development framework to build The PageTop core API provides a comprehensive toolkit for extending its functionalities to specific
secure and modular Server-Side Rendering (SSR) web solutions. 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 * **Actions** serve as a mechanism to customize PageTop's internal behavior by intercepting its
crates to provide extensible and easily configurable features. execution flow.
* **Components** encapsulate HTML, CSS, and JavaScript into functional, configurable, and
# 🚧 Warning well-defined units.
* **Packages** extend or customize existing functionality by interacting with PageTop APIs or
**PageTop** framework is currently in active development. The API is unstable and subject to third-party package APIs.
frequent changes. Production use is not recommended until version **0.1.0**. * **Themes** enable developers to alter the appearance of pages and components without affecting
their functionality.
# ⚡️ Quick start # ⚡️ Quick start
@ -61,8 +65,8 @@ distinct role within the PageTop ecosystem:
* [drust](https://github.com/manuelcillero/pagetop/tree/main/drust): * [drust](https://github.com/manuelcillero/pagetop/tree/main/drust):
A simple Content Management System (CMS) built on PageTop, which enables the creation, editing, 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 and maintenance of dynamic, fast, and modular websites. It uses the following essential packages
provide standard CMS functionalities. to provide standard CMS functionalities.
## Helpers ## Helpers
@ -94,6 +98,12 @@ distinct role within the PageTop ecosystem:
Utilizes the *[Bulma](https://bulma.io/)* framework for sleek, responsive design elements. 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 # 📜 License
PageTop is free, open source and permissively licensed! Except where noted (below and/or in PageTop is free, open source and permissively licensed! Except where noted (below and/or in

4
helpers/pagetop-build/README.md
View file

@ -4,8 +4,8 @@ applications.
# 📦 About PageTop # 📦 About PageTop
[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web [PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side
development framework to build secure and modular Server-Side Rendering (SSR) web solutions. Rendering* web solutions.
# 🚧 Warning # 🚧 Warning

4
helpers/pagetop-macros/README.md
View file

@ -3,8 +3,8 @@ A collection of procedural macros that enhance the development experience within
# 📦 About PageTop # 📦 About PageTop
[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web [PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side
development framework to build secure and modular Server-Side Rendering (SSR) web solutions. Rendering* web solutions.
# 🚧 Warning # 🚧 Warning

4
packages/pagetop-admin/README.md
View file

@ -4,8 +4,8 @@ package settings.
# 📦 About PageTop # 📦 About PageTop
[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web [PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side
development framework to build secure and modular Server-Side Rendering (SSR) web solutions. Rendering* web solutions.
# 🚧 Warning # 🚧 Warning

4
packages/pagetop-bootsier/README.md
View file

@ -4,8 +4,8 @@ versatile page layouts and component stylings.
# 📦 About PageTop # 📦 About PageTop
[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web [PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side
development framework to build secure and modular Server-Side Rendering (SSR) web solutions. Rendering* web solutions.
# 🚧 Warning # 🚧 Warning

4
packages/pagetop-bulmix/README.md
View file

@ -4,8 +4,8 @@ design elements.
# 📦 About PageTop # 📦 About PageTop
[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web [PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side
development framework to build secure and modular Server-Side Rendering (SSR) web solutions. Rendering* web solutions.
# 🚧 Warning # 🚧 Warning

4
packages/pagetop-node/README.md
View file

@ -4,8 +4,8 @@ content management.
# 📦 About PageTop # 📦 About PageTop
[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web [PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side
development framework to build secure and modular Server-Side Rendering (SSR) web solutions. Rendering* web solutions.
# 🚧 Warning # 🚧 Warning

4
packages/pagetop-user/README.md
View file

@ -4,8 +4,8 @@ built on **PageTop**.
# 📦 About PageTop # 📦 About PageTop
[PageTop](https://docs.rs/pagetop) is an opinionated [Rust](https://www.rust-lang.org) web [PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side
development framework to build secure and modular Server-Side Rendering (SSR) web solutions. Rendering* web solutions.
# 🚧 Warning # 🚧 Warning

20
src/lib.rs
View file

@ -1,19 +1,19 @@
//! <div align="center"> //! <div align="center">
//! //!
//! <img src="https://raw.githubusercontent.com/manuelcillero/pagetop/main/static/banner.png" /> //! <img src="https://raw.githubusercontent.com/manuelcillero/pagetop/main/static/banner.png" />
//! //!
//! <h1>PageTop</h1> //! <h1>PageTop</h1>
//! //!
//! [![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](https://github.com/manuelcillero/pagetop#-license) //! <p>An opinionated web framework to build modular <em>Server-Side Rendering</em> web solutions.</p>
//! [![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)
//! //!
//! [![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)
//!
//! <br>
//! </div> //! </div>
//! //!
//! **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 //! The PageTop core API provides a comprehensive toolkit for extending its functionalities to
//! specific requirements and application scenarios through actions, components, packages, and //! specific requirements and application scenarios through actions, components, packages, and
//! themes: //! themes:
@ -54,7 +54,7 @@
//! This program implements a package named `HelloWorld` with one service that returns a web page //! 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 //! 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 //! 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 //! # 🧩 Dependency Management
//! //!