Configuration
EasyDocs reads one JSON configuration file. The following example includes the site, documentation, and product settings used by the built-in builders:
{
"Name": "My Documentation",
"Description": "A static documentation site",
"AuthorName": "Ater",
"ContetPath": "./Content",
"OutputPath": "./WebSite",
"BaseHref": "/",
"Domain": "https://example.com",
"RepositoryUrl": "https://github.com/example/docs",
"Branch": "main",
"Icon": "favicon.ico",
"DocInfos": [
{
"Name": "EasyDocs",
"Languages": ["en-US", "zh-CN"],
"Versions": ["2.0"]
}
],
"ProductInfos": [
{
"Name": "MyProduct",
"Description": "A multilingual product guide",
"Logo": "logo.svg",
"Languages": ["en-US", "zh-CN"],
"DefaultLanguage": "en-US"
}
]
}
Important properties
ContetPathis intentionally spelled with the existing compatibility typo. Do not rename it toContentPathin existing configuration files.OutputPathis the generated static-site directory.BaseHrefmust end with/. Use/for a site deployed at the domain root.Domainis optional. When present, it is used to build canonical URLs andsitemap.xml.RepositoryUrlandBranchenable documentation edit links.DocInfosdeclares documentation names, languages, and versions. Every declaration must have a matching directory.ProductInfosdeclares products and their supported languages.DefaultLanguagemust be listed inLanguagesand its directory must exist.
Property names are case-sensitive in the JSON contract. Language and version directory names should match the configured values exactly.
In this article