Quick Start
Create or select a repository for the site content, then initialize it:
mkdir MyDocs cd MyDocs ezdoc init .
init creates webinfo.json, a Content directory, example documentation directories, a blog directory, and about.md. The path is optional; without it, the current directory is used.
Add Markdown files under Content, then build the site:
ezdoc build .\webinfo.json
The output directory is controlled by OutputPath and defaults to ./WebSite. Preview it with any static-file server:
npx http-server .\WebSite
A minimal workflow
- Keep
webinfo.jsonat the repository root. - Put blogs, docs, products, and custom assets under
Content. - Declare every documentation project, language, and version in
DocInfos. - Run
ezdoc build .\webinfo.jsonafter content changes. - Deploy the complete output directory.
The generator can be run from any directory when the configuration path is supplied explicitly.
In this article