https://github.com/lunofe/mcss-frontend
Python generated, component-based frontend for LeStegii/server-softwares, styled with the semantic Pico CSS framework
https://github.com/lunofe/mcss-frontend
Last synced: about 2 months ago
JSON representation
Python generated, component-based frontend for LeStegii/server-softwares, styled with the semantic Pico CSS framework
- Host: GitHub
- URL: https://github.com/lunofe/mcss-frontend
- Owner: lunofe
- License: agpl-3.0
- Created: 2024-04-05T18:13:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-01T15:45:02.000Z (8 months ago)
- Last Synced: 2025-02-03T14:16:41.714Z (4 months ago)
- Language: HTML
- Homepage: https://lestegii.github.io/server-softwares/
- Size: 189 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minecraft Server Software Frontend
This script is designed to be used in a GitHub workflow or action to generate a static website from [`LeStegii/server-software`](https://github.com/LeStegii/server-software)' Markdown files. The generated website uses the Pico CSS library to provide a clean and modern look.
## Functionality
1. The webpages and their assignment to specific Markdown files are defined.
2. Directories are prepared and all necessary website assets are copied.
3. Various components, including the header & footer are loaded.
4. The landing page is built and GitHub anchors are replaced with internal anchors.
5. Catalog pages are constructed by loading content and performing basic replacements.
6. The content is divided into active and inactive sections, and IDs are added to anchor tags for direct linking.
7. Finally, the generated HTML files are written to the build directory.
## Dependencies
- Python 3.10+
- BeautifulSoup4
- Markdown
## Set up development environment
1. Clone [`LeStegii/server-software`](https://github.com/LeStegii/server-software)
2. Clone this repository into `sever-software/mcss-frontend` directory
3. `pip install markdown beautifulsoup4`
4. Run `python mcss-frontend/build.py` (your working directory needs to be `server-software`) to generate the website