An open API service indexing awesome lists of open source software.

https://github.com/dev2forge/docs

Dev2Forge DOCS Projects
https://github.com/dev2forge/docs

dev2forge docs docs-dev2forge docs-site website

Last synced: about 2 months ago
JSON representation

Dev2Forge DOCS Projects

Awesome Lists containing this project

README

          

# [Dev2Forge](https://dev2forge.is-a.software) Documentation Portal

Welcome to the official documentation portal for [Dev2Forge](https://dev2forge.is-a.software), your comprehensive resource for open-source software projects, modules, and tools developed by the Dev2Forge organisation.

---

## 📚 Overview

This repository hosts the static documentation website for several flagship projects, including but not limited to:

- **Chromolog**: Python module for colourful and structured console output.
- **Chromologger**: Python logging module for advanced execution tracking.
- **ESRM (Effect Screen Recorder Master)**: Screen recording application with real-time effects.
- **PDF2WORDX**: GUI tool for converting PDF files to DOCX format.
- **SQLAZO**: Python module for managing SQLite databases with ease.

Each project features its own dedicated documentation section, accessible via the website or directly within the `/docs` directory.

---

## 🗂️ Repository Structure

```
docs/
chromolog/ # Documentation for Chromolog
chromologger/ # Documentation for Chromologger
esrm/ # Documentation for ESRM
pdf2wordx/ # Documentation for PDF2WORDX
assets/ # Static assets (fonts, CSS, JS)
files/ # Localised README and language files
sqlazo/ # Documentation for SQLAZO
configs/ # Site and sitemap configuration
LICENSE
README.md # You are here!
```

---

## 🌍 Multi-language Support

The documentation supports multiple languages. Language selection is available within each section, and content is dynamically loaded based on your choice.

---

## 🚀 Getting Started

To view the documentation locally:

1. Clone this repository:
```bash
git clone https://github.com/Dev2Forge/docs.git
```
2. Open the `/docs` directory in your preferred static server or IDE with live preview.
3. Navigate to the desired project documentation via the corresponding folder.

---

## 📝 Contributing

Contributions to documentation are welcome! Please fork the repository, make your changes, and submit a pull request. Ensure your contributions maintain clarity, accuracy, and consistency across all supported languages.

---

## 📄 Licence

This project is licensed under the MIT Licence. See the [LICENSE](LICENSE) file for details.

---

## 👤 Author & Contact

**Organisation:** Dev2Forge
**Website:** [https://dev2forge.is-a.software](https://dev2forge.is-a.software)
**Contact:** [Support](mailto: dev2forge@tutamail.com)

---

For more information on each project, visit the respective documentation section or the main website.