Skip to content

Commit

Permalink
doc(main): Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ekkinox committed Jan 12, 2024
1 parent 2ae8eb6 commit 6b8db45
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
22 changes: 22 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Documentation

> Yokai automated documentation, based on [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
<!-- TOC -->
* [Public version](#public-version)
* [Contributing](#contributing)
<!-- TOC -->

## Public version

Yokai public documentation is available at [https://ankorstore.github.io/yokai/](https://ankorstore.github.io/yokai/).

## Contributing

Before triggering the [docs workflow](../.github/workflows/docs.yml), you can test your documentation changes by running:

```shell
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```

This will make the documentation available locally on [http://localhost:8000](http://localhost:8000).
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

> Simple, modular, and observable Go framework.
![Image title](assets/images/yokai.png)
![Image title](assets/images/yokai.png){align=center width="350" height="350"}

# Overview
!!! info
The complete Yokai documentation is coming soon !

This documentation compiles all the essential information for building applications using [Yokai](https://github.com/ankorstore/yokai).

0 comments on commit 6b8db45

Please sign in to comment.