diff --git a/README.md b/README.md index 20ced3b..4dda039 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,4 @@ [![Maven Central](https://img.shields.io/maven-central/v/com.github.alexarchambault/case-app_3.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.alexarchambault/case-app_3) [![javadoc](https://javadoc.io/badge2/com.github.alexarchambault/case-app_3/javadoc.svg)](https://javadoc.io/doc/com.github.alexarchambault/case-app_3) -See the [website](https://alexarchambault.github.io/case-app/) for more details ([website sources on GitHub](https://github.com/alexarchambault/case-app/tree/main/docs/pages) if the website isn't responsive) +See the [website](https://alexarchambault.github.io/case-app/) for more details. Website built with [![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index aa6d1e9..b9ca6a1 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -3,15 +3,17 @@ site_name: case-app nav: - Home: 'index.md' - 'setup.md' - - 'define.md' - - 'types.md' - - 'parse.md' - - 'help.md' - - 'commands.md' - - 'completion.md' - - 'misc.md' - - 'advanced.md' - - 'develop.md' + - API: + - 'define.md' + - 'types.md' + - 'parse.md' + - 'help.md' + - 'commands.md' + - 'completion.md' + - 'misc.md' + - 'advanced.md' + - Contributing: + - 'contrib-website.md' repo_url: https://github.com/alexarchambault/case-app edit_uri: edit/main/docs/pages/ diff --git a/docs/pages/develop.md b/docs/pages/contrib-website.md similarity index 95% rename from docs/pages/develop.md rename to docs/pages/contrib-website.md index 074ae99..906f08f 100644 --- a/docs/pages/develop.md +++ b/docs/pages/contrib-website.md @@ -1,4 +1,4 @@ -# Contributing +# Website ## Building the website locally