Jdg

Overview:

JDG (Jednoosobowa działalność gospodarcza) is a theme for creating static websites using MkDocs and markdown files. It provides users with a simple and efficient way to generate a professional-looking website without advanced coding skills.

Features:

• MkDocs Generator: Utilizes MkDocs to generate static websites from markdown files.
• Easy Contribution: Users can fork the project, create a new branch, make changes, and submit a pull request for contribution.
• Local Setup: Provides step-by-step instructions for installing necessary dependencies and running the project locally.
• Docker Support: Users have the option to set up and run the project using Docker and Docker Compose.
• Obsidian Integration: Users can edit markdown files in Obsidian and instantly view the rendered output.

Normal Way:

1. Install Python 3+.
2. Install project dependencies using the command:

   pip install -r requirements.txt
   

3. Run the project.

Docker Way:

1. Install Docker and Docker Compose.
2. Run the following command:

   docker-compose up
   

Summary:

JDG theme offers a convenient solution for creating static websites using markdown files and MkDocs. With features like easy contribution, local setup guide, Docker support, and Obsidian integration, users can efficiently build and customize their websites. Whether you prefer a traditional setup or using Docker, JDG provides flexibility and ease of use in website development.