diff --git a/Pipfile b/Pipfile index 74acba82..ae1bb702 100644 --- a/Pipfile +++ b/Pipfile @@ -28,3 +28,4 @@ flake8 = "*" ipaddress = "*" tblib = "*" mkdocs = "*" +mkdocs-material = "*" diff --git a/README.md b/README.md index 17a32cc4..e98980d0 100644 --- a/README.md +++ b/README.md @@ -26,20 +26,19 @@ The demo instance resets every hour. Login credentials are: ## Documentation -- [Deployment](/docs/deployment.md) -- [Configuration](/docs/configuration.md) -- [Import/Export](/docs/import_export.md) -- [API](/docs/api.md) -- [Contributing](/docs/contributing.md) +Visit [https://docs.baby-buddy.net](https://docs.baby-buddy.net) for full documentation. + +### Additional documentation + - [Changelog](/CHANGELOG.md) - [Security](/SECURITY.md) -- [LICENSE](/LICENSE) (BSD-2 Clause) +- [License](/LICENSE) (BSD-2 Clause) ## Languages Baby Buddy is available in a variety of languages thanks to the efforts of numerous translators. Language can be set on a per-user basis from the user settings page -(`/user/settings/`). See [CONTRIBUTING.md](/docs/contributing.md#translation) +(`/user/settings/`). See [Contributing](https://docs.baby-buddy.net/contributing/#translation) for information about how to create/update translations. ### Available languages diff --git a/docs/assets/favicon.svg b/docs/assets/favicon.svg new file mode 100644 index 00000000..099a6ac2 --- /dev/null +++ b/docs/assets/favicon.svg @@ -0,0 +1,19 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 00000000..475b8f8f --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/contributing.md b/docs/contributing.md index 5bf7c242..2be97b82 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -120,7 +120,7 @@ documentation section: [Translation](https://docs.djangoproject.com/en/3.0/topic export DJANGO_SETTINGS_MODULE=babybuddy.settings.development This process will differ based on the host OS. The above example is for - Linux-based systems. See [Configuration](/docs/configuration.md) for other + Linux-based systems. See [Configuration](/configuration) for other settings and methods for defining them. 1. Migrate the database diff --git a/docs/css/extras.css b/docs/css/extras.css new file mode 100644 index 00000000..273825d6 --- /dev/null +++ b/docs/css/extras.css @@ -0,0 +1,8 @@ +:root { + --md-primary-fg-color: #37abe9; + --md-accent-fg-color: #ff8f00; +} + +.md-header__title { + margin-left: 0 !important; +} diff --git a/docs/deployment.md b/docs/deployment.md index 76866a34..d8990358 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -4,7 +4,7 @@ The default username and password for Baby Buddy is `admin`/`admin`. For any deployment, **log in and change the default password immediately**. Many of Baby Buddy's configuration settings can be controlled using environment -variables - see [Configuration](/docs/configuration.md) for detailed information. +variables - see [Configuration](/configuration) for detailed information. ## Docker @@ -54,7 +54,7 @@ create the following settings before pushing: heroku config:set DISABLE_COLLECTSTATIC=1 heroku config:set TIME_ZONE= -See [Configuration](/docs/configuration.md) for other settings that can be controlled +See [Configuration](/configuration) for other settings that can be controlled by `heroku config:set`. After an initial push, execute the following commands: diff --git a/mkdocs.yml b/mkdocs.yml index 88785410..a813123f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,17 @@ -site_name: Baby Buddy -site_url: https://docs.baby-buddy.net - -theme: readthedocs \ No newline at end of file +extra_css: + - css/extras.css +theme: + name: material + favicon: assets/favicon.svg + features: + - navigation.instant + - navigation.tracking + - search.share + - search.suggest + logo: assets/logo.svg + palette: + scheme: slate +repo_name: babybuddy/babybuddy +repo_url: https://github.com/babybuddy/babybuddy +site_name: Baby Buddy Documentation +site_url: https://docs.baby-buddy.net \ No newline at end of file