mkdocs.yml

site_name: WordOps Documentation
site_description: Wordops documentation and user guides
copyright: 'Copyright &copy; 2022 WordOps - <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img style="display:inline;" alt="Licence Creative Commons" style="border-width:0" src="https://docs.wordops.net/images/80x15.png" /></a>'
repo_url: https://github.com/WordOps/WordOps/
edit_uri: "https://github.com/WordOps/docs.wordops.net/edit/master/docs/"
remote_branch: gh-pages

theme:
  name: 'material'
  favicon: 'images/favicon.png'
  logo: 'images/logo-icon.png'
  language: 'en'
  font: false
  highlightjs: true
  palette:
    primary: 'light-blue'
    accent: 'indigo'
  feature:
    tabs: true


markdown_extensions:
  # Code highlighting in ``` ``` blocks
  - codehilite:
      guess_lang: true
# Table of Contents
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
# block div
  - admonition
  - meta

extra_css:
  - css/extra.css
  - css/asciinema-player.min.css

extra_javascript:
  - 'js/asciinema-player.js'


nav:
- Home: 'README.md'
- About:
  - Give WordOps a Github star: 'about/give-wordops-github-star.md'
  - From EasyEngine to WordOps: 'about/from-easyengine-to-wordops.md'
  - Changelog: 'about/changelog.md'
  - Contributing: 'about/contributing.md'
  - Code of conduct: 'about/code-of-conduct.md'
  - Contributors: 'https://github.com/WordOps/WordOps/graphs/contributors'
- Getting Started:
  - Prerequisites: 'getting-started/prerequesites.md'
  - Installation: 'getting-started/installation-guide.md'
  - Post-install steps: 'getting-started/post-install-steps.md'
  - Creating sites: 'getting-started/creating-sites.md'
  - WordOps structure: 'getting-started/wordops-structure.md'
- Commands:
  - Overview: 'commands.md'
  - site: 'commands/site.md'
  - stack: 'commands/stack.md'
  - debug: 'commands/debug.md'
  - clean: 'commands/clean.md'
  - info: 'commands/info.md'
  - log: 'commands/log.md'
  - secure: 'commands/secure.md'
  - maintenance: 'commands/maintenance.md'
  - update: 'commands/update.md'
- How to :
  - Overview: 'how-to.md'
  - Set WordPress language: 'how-to/wp-language.md'
  - Secure WordOps backend: 'how-to/secure-22222.md'
  - Configure LetsEncrypt DNS API : 'how-to/configure-letsencrypt-dns-api-validation.md'
  - Get A+ grade on ssllabs: 'how-to/get-a-plus-grade-ssllabs.md'
  - Add FTP users: 'how-to/add-ftp-users.md'
  - Remote MySQL server with WordOps: 'how-to/remote-mysql-server.md'
  - Install HWE stacks on Ubuntu: 'how-to/ubuntu-lts-hwe-stacks.md'
- Guides:
  - Overview: 'guides.md'
  - EasyEngine Migration: 'guides/migration-from-easyengine.md'
  - LetsEncrypt SSL certificates: 'guides/manage-ssl-certificates.md'
  - WordPress sites migration: 'guides/wordpress-migration.md'
  - WordOps With DigitalOcean volumes: 'guides/wordops-with-digitalocean-volume.md'
  - Enable live kernel patching on Ubuntu: 'guides/enable-live-kernel-patching.md'
- F.A.Q: 'https://wordops.net/f-a-q/'
- WordOps.net: https://wordops.net
- Blog: https://wordops.net/blog/
- Forum: https://community.wordops.net
- Chat: https://chat.wordops.net
- Twitter: https://twitter.com/WordOps_
- Mastodon: https://mastodon.top/@WordOps
- Troubleshooting:
  - Bug reporting guidelines: 'troubleshooting/bug-reporting.md'
  - Common issues: 'troubleshooting/common-issues.md'

extra:
  social:
    - type: globe
      link: https://wordops.net
    - type: github-alt
      link: https://github.com/WordOps
    - type: twitter
      link: https://twitter.com/WordOps_
    - type: slack
      link: https://community.wordops.io/slack
    - type: comments
      link: https://community.wordops.net
  manifest: 'manifest.webmanifest'