docs added and reskinning

compose.yaml

@@ -131,7 +131,7 @@ services:
 
         container_name: apis.cardplayersunited.com
 
-        image: dpage/apis.cardplayersunited.com
+        image: apis.cardplayersunited.com
 
         build:
 
@@ -162,3 +162,23 @@ services:
             - POSTGRES_PASSWORD=maverickdb
 
             - POSTGRES_HOST=card-players-unite-postgres
+
+## documentation
+
+    docs.cardplayersunited.com:
+
+        container_name: docs.cardplayersunited.com
+
+        image: docs.cardplayersunited.com
+
+        build:
+
+            context: docs
+
+            dockerfile: Dockerfile
+
+        restart: unless-stopped
+
+        ports:
+
+            - 8000:80

docs/.dockerignore

@@ -0,0 +1,11 @@
+.git
+
+.pristine
+
+.trash
+
+.recycle
+
+.backup
+
+.template

docs/.gitignore

@@ -0,0 +1,7 @@
+pdf/
+
+export/
+
+site/
+
+*.dat

docs/Dockerfile

@@ -0,0 +1,16 @@
+FROM titom73/mkdocs AS mkdocsBuild
+
+RUN pip install markupsafe==2.0.1
+
+RUN pip install mkdocs-blog-plugin
+
+WORKDIR /docs
+
+COPY . . 
+
+RUN mkdocs build
+
+FROM mengzyou/bbhttpd:1.35
+
+COPY --from=mkdocsBuild --chown=www:www /docs/site /home/www/html
+

docs/Jenkinsfile

@@ -0,0 +1,56 @@
+pipeline {
+
+    agent none
+
+    options {
+
+        disableConcurrentBuilds(abortPrevious: true)
+
+        buildDiscarder(logRotator(numToKeepStr: '10'))
+    }
+
+    stages {
+
+        stage('docker compose build') {
+
+            agent {
+
+                label "gulfstream"
+
+            }
+
+            steps {
+
+                dir('.') {
+
+                    sh 'docker compose build'
+
+                }
+
+            }
+
+        }
+
+        stage('docker compose push') {
+
+            agent {
+
+                label "gulfstream"
+
+            }
+
+            steps {
+
+                dir('.') {
+
+                    sh 'docker compose push'
+
+                }
+
+            }
+
+        }
+
+    }
+
+}

docs/compose.bash

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+##
+
+set -e
+
+set -x
+
+##
+
+reset
+
+clear
+
+##
+
+docker compose down --remove-orphans
+
+docker compose up --build -d

docs/compose.yaml

@@ -0,0 +1,23 @@
+services:
+
+    lorem-ipsum-dolor-sit:
+
+        container_name: lorem-ipsum-dolor-sit
+
+        image: softwareshinobi/consectetur-adipiscing-ebook
+
+        build:
+
+            context: .
+
+            dockerfile: Dockerfile
+
+        ports:
+
+            - 8000:80
+
+        environment:
+
+            VIRTUAL_HOST: lorem.ipsum.example
+
+            LETSENCRYPT_HOST: lorem.ipsum.example

docs/ebook.bash

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+##
+
+set -e
+
+set -v
+
+##
+
+reset
+
+clear
+
+##
+
+ENABLE_PDF_EXPORT=1 mkdocs build -f mkdocs.pdf.yml
+
+rm -rf site/
+
+##
+
+for file in pdf/*.pdf; do firefox "$file" & done
+
+##
+
+

docs/legacy/readme.md

@@ -0,0 +1,43 @@
+# intro
+
+![Card Players Unite](/docs/imagery/cover.png)
+
+## Developer Documentation
+
+You can run the app at home.
+
+Follow the instructions below on an Ubuntu Linux server.
+
+[Developer Docs](/docs/index.md)
+
+## Tools & Tech
+
+the tools and tech
+
+| website | how the site helped |
+|---------|---------------------|
+|[Bootswatch](https://bootswatch.com/)|bootstrap compatible prebuild color theming and css|
+|[Digital Ocean](https://www.digitalocean.com/community/tutorials)|cloud server hosting and tutorials|
+|[Internet Tutorials](/docs/tutorials.md)|various tutorials from the internet with how-to help and information|
+|[Stock Imagery](/docs/attribution.md)|free stock imagery from the internet, with attribution.|
+|[TOC Generator](https://ecotrust-canada.github.io/markdown-toc/)|github wiki toc generator.|
+|[Jigsaw validator](https://jigsaw.w3.org/css-validator/)|Validator CSS and HTML|
+|[Browserstack](https://www.browserstack.com/responsive)|Responsiveness|
+
+## Quick Start Guide
+
+You can run the app at home.
+
+Follow the instructions below on an Ubuntu Linux server.
+
+[Quick Start Guide](/docs/quick-start.md)
+
+### Preview Card Players Unite
+
+![Card Players Unite](/docs/imagery/cover.png)
+
+the app is deployed and available for usage.
+
+Click the link below to access Card Players Unite.
+
+[Access Card Players Unite](https://cardplayersunite.online/)

docs/license.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

docs/mkdocs.bash

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+##
+
+reset
+
+clear
+
+##
+
+set -e
+
+set -x
+
+##
+
+mkdocs serve

docs/mkdocs.pdf.yml

@@ -0,0 +1,51 @@
+site_name: "Lorem Ipsum (Dolor Sit)"
+
+docs_dir: "pages"
+
+site_dir: "pdf"
+
+theme:
+
+    name: material
+
+    highlightjs: true
+
+    hljs_languages:
+
+        - bash
+
+        - yaml
+
+        - java
+
+        - python
+
+plugins:
+
+    - to-pdf:
+
+        author: "Consectetur Adipiscing"
+
+        copyright: "All Rights Reserved. Lorem Ipsum 2025."
+
+        output_path: "lorem-ipsum-101.pdf"
+
+        cover: true
+
+        cover_title: "Lorem Ipsum 101"
+
+        cover_subtitle: "The definitive guide to filler text"
+
+        cover_logo: "cover.png"
+
+        toc_title: "Indice Contentorum"
+
+        toc_level: 3
+
+        ordered_chapter_level: 2
+
+        enabled_if_env: ENABLE_PDF_EXPORT
+
+extra_css:
+
+    - styling.css

docs/mkdocs.yml

@@ -0,0 +1,62 @@
+##
+## Project information
+##
+
+site_name: "Lorem Ipsum Dolor"
+
+site_favicon: favicon.svg
+
+docs_dir: "pages"
+
+site_author: "Consectetur Adipiscing"
+
+##site_url: https://lorem-ipsum.example.io/
+##site_description: >-
+##  Sed ut perspiciatis unde omnis iste natus error sit voluptatem
+##  accusantium doloremque laudantium, totam rem aperiam.
+
+# Repository
+##repo_name: lorem/ipsum-dolor
+##repo_url: https://github.com/lorem/ipsum-dolor
+
+# Copyright
+##copyright: Copyright © 2023 - 2025 Lorem Ipsum
+
+theme:
+
+    ##
+    ## Find More Themes Here:
+    ##
+    ##     https://mkdocs.github.io/mkdocs-bootswatch/
+    ##
+    ## List of theme values:
+    ##
+    ##     mkdocs, readthedocs, material, cerulean, cosmo,
+    ##     cyborg, darkly, flatly, journal, litera, lumen, lux,
+    ##     materia, minty, pulse, sandstone, simplex, slate, solar,
+    ##     spacelab, superhero, united, yeti
+    ##
+
+    name: material
+
+    ##
+    ## you can alternate colors for the navigation header.
+    ##
+    ## Allowed values: primary (the default), dark, and light:
+    ##
+
+    nav_style: primary
+
+    highlightjs: true
+
+    hljs_languages:
+
+        - bash
+
+        - yaml
+
+        - java
+
+        - python
+
+extra_css: [styling.css]

docs/pages/index.md

@@ -0,0 +1,41 @@
+# Curabitur Sodales Ligula
+
+![Lorem Ipsum Ebook](cover.png)
+
+## Introduction
+
+**Lorem ipsum dolor sit amet**, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+
+* **Integer** nec odio.
+* **Praesent** libero.
+* **Sed cursus** ante dapibus diam.
+
+## Section I: Phasellus Porttitor
+
+Phasellus porttitor, enim ut fermentum dignissim, ante neque aliquam tellus, vitae iaculis lacus elit id tortor.
+
+> "Nulla facilisi. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum."
+
+### Sub-section A
+
+Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt.
+
+1. **Primis in faucibus**: Orci luctus et ultrices posuere cubilia Curae.
+2. **Suspendisse sollicitudin**: Velit sed leo.
+3. **Ut leo**: Amet, adipiscing vitae, ultricies sit amet, tempor sit amet, ante.
+
+---
+
+## Section II: Analysis of Data
+
+In this section, we observe the relationship between variables as defined by the following expression:
+
+| Category | Value A | Value B |
+| --- | --- | --- |
+| Alpha | 10.5 | 20.2 |
+| Beta | 15.1 | 18.9 |
+| Gamma | 12.3 | 21.0 |
+
+## Conclusion
+
+Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu.

docs/pages/styling.css

@@ -0,0 +1,17 @@
+/* PDF Watermark Styling */
+@media print {
+    body::before {
+        content: "LOREM IPSUM"; /* Change this to your desired text */
+        position: fixed;
+        top: 50%;
+        left: 50%;
+        transform: translate(-50%, -50%) rotate(-45deg);
+        font-size: 100pt;
+        color: rgba(0, 0, 0, 0.07); /* subtle grey opacity */
+        z-index: -1000;
+        white-space: nowrap;
+        pointer-events: none;
+        font-family: sans-serif;
+        font-weight: bold;
+    }
+}

docs/provision.bash

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+set -x
+
+##
+
+apt update
+
+##
+
+apt install pip -y
+
+##
+
+pip install mkdocs-material
+
+##
+
+pip install mkdocs-with-pdf --break-system-packages
+
+pip install mkdocs-to-pdf

docs/readme.md

@@ -1,43 +1,57 @@
-# intro
+# Lorem Ipsum Ebook Starter
 
-![Card Players Unite](/docs/imagery/cover.png)
+This repository is a professional boilerplate for creating searchable, high-quality ebooks and documentation sites using **MkDocs**. It is pre-configured to support local development via Docker and automated PDF generation.
 
-## Developer Documentation
+![Lorem Ipsum Ebook](cover.png)
 
-You can run the app at home.
+## 🚀 Features
 
-Follow the instructions below on an Ubuntu Linux server.
+* **Documentation Site**: Powered by MkDocs with the `readthedocs` theme.
 
-[Developer Docs](/docs/index.md)
+* **PDF Export**: Built-in support for generating professional PDF versions of your content.
 
-## Tools & Tech
+* **Dockerized**: Simple deployment and local testing using Docker Compose.
 
-the tools and tech
+* **Syntax Highlighting**: Pre-configured for YAML and Rust.
 
-| website | how the site helped |
+* **Custom Styling**: Integrated CSS support for branding and layout adjustments.
-|---------|---------------------|
-|[Bootswatch](https://bootswatch.com/)|bootstrap compatible prebuild color theming and css|
-|[Digital Ocean](https://www.digitalocean.com/community/tutorials)|cloud server hosting and tutorials|
-|[Internet Tutorials](/docs/tutorials.md)|various tutorials from the internet with how-to help and information|
-|[Stock Imagery](/docs/attribution.md)|free stock imagery from the internet, with attribution.|
-|[TOC Generator](https://ecotrust-canada.github.io/markdown-toc/)|github wiki toc generator.|
-|[Jigsaw validator](https://jigsaw.w3.org/css-validator/)|Validator CSS and HTML|
-|[Browserstack](https://www.browserstack.com/responsive)|Responsiveness|
 
-## Quick Start Guide
+## 📂 Project Structure
 
-You can run the app at home.
+* `pages/`: Contains the Markdown source files for your ebook.
 
-Follow the instructions below on an Ubuntu Linux server.
+* `pdf/`: The output directory for generated PDF files (ignored by git).
 
-[Quick Start Guide](/docs/quick-start.md)
+* `mkdocs.yml`: The main configuration file for project metadata, themes, and plugins.
 
-### Preview Card Players Unite
+* `compose.yaml`: Defines the Docker services for serving the site locally.
 
-![Card Players Unite](/docs/imagery/cover.png)
+* `compose.bash`: A helper script to quickly rebuild and restart the Docker environment.
 
-the app is deployed and available for usage.
+## 🛠️ Getting Started
 
-Click the link below to access Card Players Unite.
+### Prerequisites
 
-[Access Card Players Unite](https://cardplayersunite.online/)
+* Docker and Docker Compose installed on your machine.
+
+### Local Development
+
+To launch the project locally and view your ebook in a browser:
+
+1. Run the setup script:
+
+```bash
+./compose.bash
+[cite_start]``` [cite: 31744]
+
+```
+
+2. Access the site at `http://localhost:8000`.
+
+## PDF Generation
+
+The project uses the `to-pdf` plugin to automatically generate a document titled `lorem-ipsum-101.pdf`. Ensure your assets (like `assets/images/cover.jpg`) are in place to include a cover page in the export.
+
+## 📄 License
+
+This project is licensed under the Apache License, Version 2.0.

readme.md

@@ -4,6 +4,10 @@
 
 http://localhost:5480/browser/
 
+## documentation site
+
+http://localhost:8000
+
 ## view all tourney
 
 ## add new tourney