mirror of https://github.com/snachodog/mybuddy.git
Customize docs site
This commit is contained in:
Christopher C. Wells
parent
cbc2fed2fb
commit
5811755f7b
1
Pipfile
1
Pipfile
|
|
@ -28,3 +28,4 @@ flake8 = "*"
|
||||||
ipaddress = "*"
|
ipaddress = "*"
|
||||||
tblib = "*"
|
tblib = "*"
|
||||||
mkdocs = "*"
|
mkdocs = "*"
|
||||||
|
mkdocs-material = "*"
|
||||||
|
|
|
||||||
13
README.md
13
README.md
|
|
@ -26,20 +26,19 @@ The demo instance resets every hour. Login credentials are:
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
- [Deployment](/docs/deployment.md)
|
Visit [https://docs.baby-buddy.net](https://docs.baby-buddy.net) for full documentation.
|
||||||
- [Configuration](/docs/configuration.md)
|
|
||||||
- [Import/Export](/docs/import_export.md)
|
### Additional documentation
|
||||||
- [API](/docs/api.md)
|
|
||||||
- [Contributing](/docs/contributing.md)
|
|
||||||
- [Changelog](/CHANGELOG.md)
|
- [Changelog](/CHANGELOG.md)
|
||||||
- [Security](/SECURITY.md)
|
- [Security](/SECURITY.md)
|
||||||
- [LICENSE](/LICENSE) (BSD-2 Clause)
|
- [License](/LICENSE) (BSD-2 Clause)
|
||||||
|
|
||||||
## Languages
|
## Languages
|
||||||
|
|
||||||
Baby Buddy is available in a variety of languages thanks to the efforts of numerous
|
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
|
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.
|
for information about how to create/update translations.
|
||||||
|
|
||||||
### Available languages
|
### Available languages
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs" width="334.775" height="305.416">
|
||||||
|
<svg viewBox="0 0 334.8 305.416" width="334.775" height="305.416" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<g transform="matrix(1, 0, 0, 1, -910.945007, -2957.187256)">
|
||||||
|
<path d="M 1245.72 3124.074 C 1245.72 3140.012 1232.8 3152.937 1216.861 3152.937 C 1215.854 3152.937 1214.857 3152.885 1213.875 3152.784 C 1200.654 3215.512 1144.996 3262.603 1078.334 3262.603 C 1011.672 3262.603 956.014 3215.513 942.791 3152.784 C 941.81 3152.884 940.814 3152.937 939.805 3152.937 C 923.868 3152.937 910.945 3140.012 910.945 3124.074 C 910.945 3108.137 923.867 3095.211 939.805 3095.211 C 940.813 3095.211 941.81 3095.263 942.791 3095.364 C 948.427 3068.632 961.763 3044.738 980.381 3026.122 C 988.736 3017.763 998.155 3010.468 1008.416 3004.457 C 1019.223 2998.085 1030.811 2993.66 1042.643 2990.68 C 1043.827 2990.382 1045.088 2990.575 1047.084 2993.6 C 1055.451 3005.64 1071.373 3014.926 1086.63 3008.955 C 1100.56 3002.987 1107.857 2985.738 1097.906 2973.133 C 1090.61 2964.511 1077.344 2962.52 1069.383 2971.144 C 1066.729 2973.797 1066.065 2977.776 1066.065 2981.095 C 1066.065 2983.747 1068.72 2989.717 1071.374 2986.403 C 1072.7 2984.411 1074.027 2981.095 1077.345 2981.095 C 1083.315 2981.095 1086.631 2988.389 1083.315 2993.033 C 1078.007 3000.995 1066.73 2998.342 1061.422 2991.709 C 1056.116 2983.746 1056.778 2974.46 1062.749 2967.162 C 1070.71 2957.213 1084.64 2954.558 1095.917 2959.867 C 1106.531 2965.838 1114.491 2975.787 1117.216 2987.721 C 1117.751 2989.717 1118.289 2990.629 1118.805 2991.551 C 1166.616 3006.134 1203.452 3045.884 1213.882 3095.364 C 1214.862 3095.264 1215.856 3095.211 1216.862 3095.211 C 1232.802 3095.211 1245.722 3108.137 1245.72 3124.074 Z M 1128.44 3044.73 C 1115.6 3044.73 1105.191 3059.056 1105.191 3076.728 C 1105.191 3094.4 1115.6 3108.726 1128.44 3108.726 C 1141.28 3108.726 1151.689 3094.4 1151.689 3076.728 C 1151.689 3059.056 1141.28 3044.73 1128.44 3044.73 Z M 1096.433 3124.369 C 1095.485 3118.022 1091.363 3112.723 1085.721 3110.134 L 1082.624 3038.051 L 1073.237 3038.051 L 1070.141 3110.134 C 1068.02 3111.107 1066.111 3112.456 1064.502 3114.11 L 1049.807 3109.387 L 1044.569 3128.472 L 1059.852 3131.971 C 1061.16 3136.875 1064.394 3140.987 1068.711 3143.438 L 1068.036 3159.146 L 1087.826 3159.146 L 1087.152 3143.437 C 1089.033 3142.368 1090.709 3140.986 1092.113 3139.357 L 1163.773 3155.761 L 1165.812 3146.663 Z M 1028.229 3044.73 C 1015.389 3044.73 1004.98 3059.056 1004.98 3076.728 C 1004.98 3094.4 1015.389 3108.726 1028.229 3108.726 C 1041.069 3108.726 1051.478 3094.4 1051.478 3076.728 C 1051.478 3059.056 1041.069 3044.73 1028.229 3044.73 Z M 1078.335 3211.453 C 1099.214 3211.453 1116.142 3195.273 1116.142 3175.311 L 1040.529 3175.311 C 1040.528 3195.273 1057.454 3211.453 1078.335 3211.453 Z"></path>
|
||||||
|
<path d="M1029.979,3067.189c0,6.369-3.755,11.536-8.383,11.536c-4.631,0-8.383-5.167-8.383-11.536 c0-6.375,3.752-11.54,8.383-11.54C1026.225,3055.649,1029.979,3060.814,1029.979,3067.189z"></path>
|
||||||
|
<path d="M1130.19,3067.189c0,6.369-3.755,11.536-8.383,11.536c-4.631,0-8.383-5.167-8.383-11.536 c0-6.375,3.752-11.54,8.383-11.54C1126.436,3055.649,1130.19,3060.814,1130.19,3067.189z"></path>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
<style>
|
||||||
|
path {
|
||||||
|
fill: #37ABE9;
|
||||||
|
}
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
path {
|
||||||
|
fill: #FFFFFF;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 3.4 KiB |
|
|
@ -0,0 +1,8 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<svg viewBox="0 0 334.8 305.416" width="334.775" height="305.416" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<g transform="matrix(1, 0, 0, 1, -910.945007, -2957.187256)">
|
||||||
|
<path fill="#FFFFFF" d="M 1245.72 3124.074 C 1245.72 3140.012 1232.8 3152.937 1216.861 3152.937 C 1215.854 3152.937 1214.857 3152.885 1213.875 3152.784 C 1200.654 3215.512 1144.996 3262.603 1078.334 3262.603 C 1011.672 3262.603 956.014 3215.513 942.791 3152.784 C 941.81 3152.884 940.814 3152.937 939.805 3152.937 C 923.868 3152.937 910.945 3140.012 910.945 3124.074 C 910.945 3108.137 923.867 3095.211 939.805 3095.211 C 940.813 3095.211 941.81 3095.263 942.791 3095.364 C 948.427 3068.632 961.763 3044.738 980.381 3026.122 C 988.736 3017.763 998.155 3010.468 1008.416 3004.457 C 1019.223 2998.085 1030.811 2993.66 1042.643 2990.68 C 1043.827 2990.382 1045.088 2990.575 1047.084 2993.6 C 1055.451 3005.64 1071.373 3014.926 1086.63 3008.955 C 1100.56 3002.987 1107.857 2985.738 1097.906 2973.133 C 1090.61 2964.511 1077.344 2962.52 1069.383 2971.144 C 1066.729 2973.797 1066.065 2977.776 1066.065 2981.095 C 1066.065 2983.747 1068.72 2989.717 1071.374 2986.403 C 1072.7 2984.411 1074.027 2981.095 1077.345 2981.095 C 1083.315 2981.095 1086.631 2988.389 1083.315 2993.033 C 1078.007 3000.995 1066.73 2998.342 1061.422 2991.709 C 1056.116 2983.746 1056.778 2974.46 1062.749 2967.162 C 1070.71 2957.213 1084.64 2954.558 1095.917 2959.867 C 1106.531 2965.838 1114.491 2975.787 1117.216 2987.721 C 1117.751 2989.717 1118.289 2990.629 1118.805 2991.551 C 1166.616 3006.134 1203.452 3045.884 1213.882 3095.364 C 1214.862 3095.264 1215.856 3095.211 1216.862 3095.211 C 1232.802 3095.211 1245.722 3108.137 1245.72 3124.074 Z M 1128.44 3044.73 C 1115.6 3044.73 1105.191 3059.056 1105.191 3076.728 C 1105.191 3094.4 1115.6 3108.726 1128.44 3108.726 C 1141.28 3108.726 1151.689 3094.4 1151.689 3076.728 C 1151.689 3059.056 1141.28 3044.73 1128.44 3044.73 Z M 1096.433 3124.369 C 1095.485 3118.022 1091.363 3112.723 1085.721 3110.134 L 1082.624 3038.051 L 1073.237 3038.051 L 1070.141 3110.134 C 1068.02 3111.107 1066.111 3112.456 1064.502 3114.11 L 1049.807 3109.387 L 1044.569 3128.472 L 1059.852 3131.971 C 1061.16 3136.875 1064.394 3140.987 1068.711 3143.438 L 1068.036 3159.146 L 1087.826 3159.146 L 1087.152 3143.437 C 1089.033 3142.368 1090.709 3140.986 1092.113 3139.357 L 1163.773 3155.761 L 1165.812 3146.663 Z M 1028.229 3044.73 C 1015.389 3044.73 1004.98 3059.056 1004.98 3076.728 C 1004.98 3094.4 1015.389 3108.726 1028.229 3108.726 C 1041.069 3108.726 1051.478 3094.4 1051.478 3076.728 C 1051.478 3059.056 1041.069 3044.73 1028.229 3044.73 Z M 1078.335 3211.453 C 1099.214 3211.453 1116.142 3195.273 1116.142 3175.311 L 1040.529 3175.311 C 1040.528 3195.273 1057.454 3211.453 1078.335 3211.453 Z"/>
|
||||||
|
<path fill="#FFFFFF" d="M1029.979,3067.189c0,6.369-3.755,11.536-8.383,11.536c-4.631,0-8.383-5.167-8.383-11.536 c0-6.375,3.752-11.54,8.383-11.54C1026.225,3055.649,1029.979,3060.814,1029.979,3067.189z"/>
|
||||||
|
<path fill="#FFFFFF" d="M1130.19,3067.189c0,6.369-3.755,11.536-8.383,11.536c-4.631,0-8.383-5.167-8.383-11.536 c0-6.375,3.752-11.54,8.383-11.54C1126.436,3055.649,1130.19,3060.814,1130.19,3067.189z"/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 3.2 KiB |
|
|
@ -120,7 +120,7 @@ documentation section: [Translation](https://docs.djangoproject.com/en/3.0/topic
|
||||||
export DJANGO_SETTINGS_MODULE=babybuddy.settings.development
|
export DJANGO_SETTINGS_MODULE=babybuddy.settings.development
|
||||||
|
|
||||||
This process will differ based on the host OS. The above example is for
|
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.
|
settings and methods for defining them.
|
||||||
|
|
||||||
1. Migrate the database
|
1. Migrate the database
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
:root {
|
||||||
|
--md-primary-fg-color: #37abe9;
|
||||||
|
--md-accent-fg-color: #ff8f00;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md-header__title {
|
||||||
|
margin-left: 0 !important;
|
||||||
|
}
|
||||||
|
|
@ -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**.
|
deployment, **log in and change the default password immediately**.
|
||||||
|
|
||||||
Many of Baby Buddy's configuration settings can be controlled using environment
|
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
|
## Docker
|
||||||
|
|
||||||
|
|
@ -54,7 +54,7 @@ create the following settings before pushing:
|
||||||
heroku config:set DISABLE_COLLECTSTATIC=1
|
heroku config:set DISABLE_COLLECTSTATIC=1
|
||||||
heroku config:set TIME_ZONE=<DESIRED DEFAULT TIMEZONE>
|
heroku config:set TIME_ZONE=<DESIRED DEFAULT TIMEZONE>
|
||||||
|
|
||||||
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`.
|
by `heroku config:set`.
|
||||||
|
|
||||||
After an initial push, execute the following commands:
|
After an initial push, execute the following commands:
|
||||||
|
|
|
||||||
19
mkdocs.yml
19
mkdocs.yml
|
|
@ -1,4 +1,17 @@
|
||||||
site_name: Baby Buddy
|
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
|
site_url: https://docs.baby-buddy.net
|
||||||
|
|
||||||
theme: readthedocs
|
|
||||||
Loading…
Reference in New Issue