card-players-united/apis.cardplayersunited.com
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs added and reskinning

Browse Source
This commit is contained in:
Software Shinobi
2026-02-19 00:45:05 -05:00
parent 7e93b14012
commit d791b80ef8
23 changed files with 679 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/readme.md
View File

@@ -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 |
|---------|---------------------|
|[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|
* **Custom Styling**: Integrated CSS support for branding and layout adjustments.
## 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.