farmOS/mkdocs.yml

site_name: farmOS 2.x Docs
nav:
  - Development:
    - API:
      - Introduction: development/api/index.md
      - Authentication: development/api/authentication.md
      - Changes: development/api/changes.md
    - Module:
      - Getting started: development/module/index.md
      - Entities: development/module/entities.md
      - Fields: development/module/fields.md
      - OAuth: development/module/oauth.md
      - Roles: development/module/roles.md
      - Updates: development/module/updates.md
    - Environment:
      - Getting started: development/environment/index.md
      - HTTPS: development/environment/https.md
      - Updating: development/environment/update.md
      - Docker: development/environment/docker.md
      - PostgreSQL: development/environment/postgresql.md
      - Drush: development/environment/drush.md
      - Composer: development/environment/composer.md
      - Debugging: development/environment/debug.md
      - Automated tests: development/environment/tests.md
      - Coding standards: development/environment/code.md
      - Documentation: development/environment/documentation.md
  - Hosting:
    - Introduction: hosting/index.md
    - 1.x Migration: hosting/migration.md
theme:
  name: material
  palette:
    primary: green
    accent: orange
  icon:
    logo: material/leaf
  favicon: favicon.ico
markdown_extensions:
  - toc:
      permalink: true
copyright: This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>. farmOS is a <a href="/community/trademark">registered trademark</a> of <a href="http://mstenta.net">Michael Stenta</a>
Change to mkdocs light theme, because readthedocs doesn't support more than 2 menu levels. 2020-11-24 05:15:40 +01:00			`site_name: farmOS 2.x Docs`
Explicitly set the nav structure in mkdocs.yml. 2020-04-30 18:23:57 +02:00			`nav:`
			`- Development:`
Rearrange menu. Move development/environment below development/module. Move api under development. Move hosting to the end. 2020-11-24 05:16:45 +01:00			`- API:`
			`- Introduction: development/api/index.md`
			`- Authentication: development/api/authentication.md`
			`- Changes: development/api/changes.md`
			`- Module:`
			`- Getting started: development/module/index.md`
Document adding new bundles and fields. 2020-12-11 20:25:02 +01:00			`- Entities: development/module/entities.md`
Rearrange menu. Move development/environment below development/module. Move api under development. Move hosting to the end. 2020-11-24 05:16:45 +01:00			`- Fields: development/module/fields.md`
			`- OAuth: development/module/oauth.md`
			`- Roles: development/module/roles.md`
Document module automated updates. 2020-12-12 12:44:23 +01:00			`- Updates: development/module/updates.md`
Nest development docs into development/environment section. 2020-10-12 02:19:28 +02:00			`- Environment:`
			`- Getting started: development/environment/index.md`
Document how to set up HTTPS for local development. 2021-02-26 02:26:48 +01:00			`- HTTPS: development/environment/https.md`
Document how to update a local environment. 2020-12-04 14:51:28 +01:00			`- Updating: development/environment/update.md`
Nest development docs into development/environment section. 2020-10-12 02:19:28 +02:00			`- Docker: development/environment/docker.md`
			`- PostgreSQL: development/environment/postgresql.md`
			`- Drush: development/environment/drush.md`
			`- Composer: development/environment/composer.md`
			`- Debugging: development/environment/debug.md`
			`- Automated tests: development/environment/tests.md`
			`- Coding standards: development/environment/code.md`
Add instructions about how to update documentation to documentation 2020-11-13 01:17:14 +01:00			`- Documentation: development/environment/documentation.md`
Rearrange menu. Move development/environment below development/module. Move api under development. Move hosting to the end. 2020-11-24 05:16:45 +01:00			`- Hosting:`
Hosting farmOS documentation. This is mostly copied from existing farmOS.org documentation, modified and updated for 2.x. 2021-02-23 21:15:01 +01:00			`- Introduction: hosting/index.md`
Rearrange menu. Move development/environment below development/module. Move api under development. Move hosting to the end. 2020-11-24 05:16:45 +01:00			`- 1.x Migration: hosting/migration.md`
Customize the material theme primary and accent colors. 2020-11-24 05:37:40 +01:00			`theme:`
			`name: material`
			`palette:`
			`primary: green`
			`accent: orange`
Set the docs logo to material/leaf. 2020-11-24 14:23:19 +01:00			`icon:`
			`logo: material/leaf`
Add favicon.ico for docs. 2020-11-24 14:23:08 +01:00			`favicon: favicon.ico`
Enable permalinks on markdown headers. 2020-11-24 05:33:31 +01:00			`markdown_extensions:`
			`- toc:`
			`permalink: true`
Replicate docs copyright notice from farmOS.org repo. 2020-11-24 23:31:40 +01:00			`copyright: This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>. farmOS is a <a href="/community/trademark">registered trademark</a> of <a href="http://mstenta.net">Michael Stenta</a>`