search menu
Customization

The meta.md file

The root _meta.md file contains the configuration for the global documentation features. This file is generated by default when you run doco init and it is located at the root of the documentation folder. The file is a markdown file that contains a set of key/value pairs that are used to customize the global options of the site. It looks like this:

---
name: Doco
description: "Doco is a CLI tool to generate static documentation websites from markdown files."
keywords: "keywords,for,seo"
index: -1
favicon: "/assets/favicon.png"
copy: "© $YEAR Doco"
github: "https://github.com/paganotoni/doco"
ogimage: "/assets/ogimage.png"

logo:
  src: "/assets/logo.png"
  link: "https://doco.paganotoni.com"

announcement:
  text: "Check our Github repository"
  link: "https://github.com/paganotoni/doco"

external_links:
  - text: "Documentation"
    link: "/"

quick_links:
  - text: "Documentation"
    link: "/"
    icon: "menu_book"
  - text: "Repository"
    link: "https://github.com/paganotoni/doco"
    icon: "code"
---

The following sections will explain each of the options available in the _meta.md file.

  • General Options
  • Quick Links
  • External Links
  • Announcement