Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tfversion/docs

Main website and documentation for tfversion
https://github.com/tfversion/docs

Last synced: 23 days ago
JSON representation

Main website and documentation for tfversion

Awesome Lists containing this project

README

        

# tfversion/docs

[![mkdocs-material](https://img.shields.io/badge/mkdocs--material-gray?logo=materialformkdocs)](https://tfversion.xyz)

Repository that hosts [docs](https://tfversion.xyz) for [tfversion](https://github.com/tfversion/tfversion).

## Development

Make sure you have Docker installed and then run `make dev` to get a live-reloading environment for writing documentation.
All documentation is written using Markdown and turned into static pages using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

## Deployment

This project is deployed to GitHub pages via GitHub Actions.
This happens automatically when merging to the `main` branch.