docmodel show menu hide menu

Landing Pages and Indexes

Section Landing Pages

To add a landing page to a section, simply add an entry in the relevant section of your documents list with an index key:

{
  "documents": {
    "#0.1.0:en": {
      "index"          : "0.1.0/index-en.md",
      "Getting Started": "getting-started.md", 
      "Something Else" : "something-else.md", 
      "A Section": {
        "index": "0.1.0/a-section-en.md",
        "Foo"  : "0.1.0/foo-en.md",
      }
    }
  }
  ...
}

For the purposed of navigation links, section landing pages will take their name from their parent key. In the above example, links to 0.1.0/a-section-en.md will be given the text A Section. The top-level section index (i.e. links to 0.1.0/index-en.md) will be in the format versionName (nativeLanguageName).

Site Index

To create an index page for your site, add an index entry to your project configuration file (docmodel.json) which points to a markdown document (relative to your documents directory):

{
  "documents": {},
  "index": "index.md"
  ...
}

Please note that this entry should not be part of your documents list--it should be added to the root of your configuration file, as demonstrated above. Translations and versions are not supported for the site index--there will only ever be 1 version of a site index.

« PreviousNext »