https://github.com/hololinked-dev/docs
Documentation in material mkdocs for hololinked
https://github.com/hololinked-dev/docs
Last synced: 4 months ago
JSON representation
Documentation in material mkdocs for hololinked
- Host: GitHub
- URL: https://github.com/hololinked-dev/docs
- Owner: hololinked-dev
- License: bsd-3-clause
- Created: 2024-12-07T08:31:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-10T18:55:10.000Z (5 months ago)
- Last Synced: 2026-02-10T22:11:02.264Z (5 months ago)
- Language: Python
- Homepage: https://docs.hololinked.dev
- Size: 1.09 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hololinked docs
Documentation in material mkdocs for [hololinked](https://github.com/hololinked-dev/hololinked).
To build the documentation, while setting up a local development environment with `uv` (`pip install uv`), run:
```bash
uv venv
source .venv/bin/activate # or venv\Scripts\activate on Windows
uv sync --no-install-project
mkdocs build
```
or
```bash
mkdocs serve
```
> This project is always looking for contributors to improve the documentation in a **hand-written** fashion.
> Hop into our [Discord](https://discord.com/invite/kEz87zqQXh) to discuss upfront if needed and make a PR with your changes.
> Contributions can include proof reading, language improvements, adding new sections, examples or tutorials, etc.
### skaffold
To develop the documentation with skaffold within a kubernetes cluster, create a `skaffold.env` file specifying the docker registry. For example, if you are using Docker Hub, it should look like this:
```bash
SKAFFOLD_DEFAULT_REPO=docker.io/
```
Please get in touch with me [by email](mailto:info@hololinked.dev) or on [discord](https://discord.com/invite/kEz87zqQXh) for cluster credentials.
```bash
skaffold dev --module dev-python-docs
```
Or use your own cluster if you have one set up. To test if the image is building
```bash
skaffold build --module dev-python-docs
```
### Docker
To build, tag, and publish the Docker image from your local machine, run:
```sh
set -e
docker build -t hololinked-docs .
docker tag hololinked-docs:latest ghcr.io/hololinked-dev/hololinked-docs:latest
docker push ghcr.io/hololinked-dev/hololinked-docs:latest
echo "Docker image built and pushed successfully."
```