Welcome to the Raku Knowledge Base repository! This project aims to provide a comprehensive, easily navigable resource for all things related to the Raku programming language.
The Raku Knowledge Base is built using Podlite, a powerful markup language for creating and managing information ecosystems. This repository contains the source files for The Raku Knowledge Base, a web-based knowledge base that includes:
- Official Raku project documentation
- Documentation for user modules
- Code examples and tutorials
- Markdown files from various sources
The primary content of this project is written in the Podlite markup language, a specialized format designed for efficient documentation and knowledge management. The specification for Podlite markup is available at https://podlite.org/specification.
- Global Search: Quickly find information across all documents.
- Term Index: Automatically generated index of important terms and concepts.
- Interactive Table of Contents: Easy navigation through long documents.
- Breadcrumb Navigation: Intuitive site structure navigation.
- Syntax Highlighting: Improved readability for code snippets.
- Markdown Support: Seamless integration of Markdown files.
We welcome contributions from the community! Here's how you can help:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with a clear, descriptive message.
- Push your changes to your fork.
- Submit a pull request to the main repository.
The majority of the content in this repository is written in the Podlite markup language. Podlite is a powerful and flexible markup language designed specifically for documentation and knowledge management. It allows for rich formatting, easy cross-referencing, and seamless integration of code examples.
To learn more about Podlite markup, please refer to the official specification.
The content of this repository is processed using a Docker image of Podlite for web. This approach ensures consistency in rendering and allows for easy deployment and scalability.
🚧 This section requires finalization of the example commands to run site generation 🚧
"Raku" is trademark of the Yet Another Society.
This project is licensed under the Artistic License 2.0.
The Artistic License 2.0 is chosen to align with the licensing of Raku itself and many Raku modules. This license provides freedom for use, modification, and distribution while ensuring that credit is given to the original authors. It's particularly well-suited for open-source language projects and their ecosystems.
For the full text of the license, please see the LICENSE file in this repository or visit the Open Source Initiative's Artistic License 2.0 page.
For questions, suggestions, or support, please open an issue in this repository or contact us at [email protected].
Thank you for your interest in improving the Raku Knowledge Base!