Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.47 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.47 KB

My MkDocs Project

This repository contains the source files for my MkDocs documentation project, using the Material for MkDocs theme.

📚 Project Overview

  • MkDocs: A fast, simple static site generator for building project documentation. Material for MkDocs: A professional, responsive theme built on Google's Material Design principles.

🚀 Live Documentation

You can view the live version of this documentation at: https://github.com/Marc-jr/mk-docs

🛠️ Local Setup

To run the project locally and preview the documentation:

  1. Clone the repository:

    git clone https://github.com/Marc-jr/mk-docs
    cd my-mkdocs-project
  2. Install MkDocs and dependencies:

    pip install mkdocs
  3. Run the MkDocs development server:

    mkdocs serve

    Open your browser and navigate to http://127.0.0.1:8000 to view the documentation locally.

📦 Build and Deploy

  • Build the site:

    mkdocs build

    This will generate static files in the site/ directory.

  • Deploy to GitHub Pages: The project is set up to automatically deploy via GitHub Actions when changes are pushed to the master branch.

    To manually deploy:

    mkdocs gh-deploy

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.