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

https://github.com/igormcsouza/knowledge-base

Research and studies I found along my software days
https://github.com/igormcsouza/knowledge-base

docker git python3

Last synced: 6 months ago
JSON representation

Research and studies I found along my software days

Awesome Lists containing this project

README

          

# Igor's Knowledge Base

A modern, searchable knowledge base built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) containing software engineering knowledge, tips, and best practices.

🔗 **[Visit the Knowledge Base](https://igormcsouza.github.io/knowledge-base/)**

## What's Inside

This repository contains comprehensive documentation on:

- **Python Development**: Tips, tricks, and best practices
- **Web Frameworks**: Flask guides and tutorials
- **Version Control**: Git commands, configurations, and workflows
- **And much more!**

## Features

- 🔍 **Full-text search** across all content
- 🏷️ **Tag-based organization** for easy discovery
- 📱 **Mobile-friendly** responsive design
- 🌙 **Dark/light mode** toggle
- 🚀 **Fast loading** with modern web technologies

## Quick Start

### Local Development

1. **Clone the repository**:

```bash
git clone https://github.com/igormcsouza/knowledge-base.git
cd knowledge-base
```

1. **Install dependencies**:

```bash
poetry install
```

1. **Start the development server**:

```bash
poetry run mkdocs serve
```

1. **Open your browser** to `http://127.0.0.1:8000`

### Contributing

Want to add content? Check out the [Getting Started guide](https://igormcsouza.github.io/knowledge-base/getting-started/) to learn how to:

- Add new pages and articles
- Use tags effectively
- Follow content guidelines
- Preview changes locally

## Deployment

The site is automatically deployed to GitHub Pages via GitHub Actions when changes are merged to the main branch.

## Follow Me

[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://linkedin.com/in/igormcsouza)
[![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/igormcsouza)
[![Website](https://img.shields.io/badge/Website-000000?style=for-the-badge&logo=About.me&logoColor=white)](https://igormcsouza.github.io/)

---

## Built with ❤️ using MkDocs Material