https://github.com/ka-sarthak/website

https://github.com/ka-sarthak/website

mkdocs mkdocs-material personal-website

Last synced: 27 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ka-sarthak/website
• Owner: ka-sarthak
• License: apache-2.0
• Created: 2025-01-03T19:27:36.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-29T01:32:03.000Z (5 months ago)
• Last Synced: 2026-01-29T16:05:09.582Z (5 months ago)
• Topics: mkdocs, mkdocs-material, personal-website
• Homepage: https://ka-sarthak.github.io
• Size: 19 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# website

Personal static website generated using [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) and [Jinja](https://jinja.palletsprojects.com/en/stable/).

The modification of the standard `materials` theme is inspired by [pawamoy](https://pawamoy.github.io/)'s beautiful website.

The generated website is graciously hosted by [GitHub](https://pages.github.com/) at [ka-sarthak.github.io](https://ka-sarthak.github.io).

## Development

- Setup environment with `pip` and run website locally.

    Clone the package, create a Python virtual environment, and install the dependencies:

    ```sh

    python -m venv .venv

    source .venv/bin/activate

    pip install .

    ```

    Run the website locally using:

    ```sh

    mkdocs serve

    ```

- Alternatively, use [uv](https://docs.astral.sh/uv/) to setup the environment and run the website locally:

    ```sh

    uv sync

    uv run mkdocs serve

    ```