https://github.com/thangbuiq/docs

technical doc mkdocs terminal
https://github.com/thangbuiq/docs

Last synced: 7 months ago
JSON representation

technical doc mkdocs terminal

• Host: GitHub
• URL: https://github.com/thangbuiq/docs
• Owner: thangbuiq
• Created: 2025-01-11T08:13:12.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-01-16T10:53:22.000Z (9 months ago)
• Last Synced: 2025-01-25T04:48:13.997Z (8 months ago)
• Homepage: http://thangbuiq.work/docs/
• Size: 1.16 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# tech docs

feel free to clone my repo and use it as a template for your own tech docs

## prerequisites

- `python3`: https://www.python.org/downloads/

- `uv`: https://github.com/astral-sh/uv

## getting started

1. clone the repo

2. install the dependencies

```bash

uv sync

```

3. start the development server

```bash

uv run mkdocs serve

```

4. open the browser and go to `http://localhost:8000`