Xiaoeyu

Xiaoeyu turns README files in a repository into a navigable Docusaurus documentation site.

Capabilities

• Collect README files from a local repository or a remote Git repository
• Apply include, exclude, and ordered rule-based filters
• Generate content/ pages and site metadata
• Scaffold a ready-to-run Docusaurus site
• Expose a reusable GitHub Action for content generation

Quick start

npm install -g xiaoeyu
xiaoeyu init
npm run start --prefix docs

If you do not want a global install, run npx xiaoeyu init.

The init wizard writes xiaoeyu.config.json, scaffolds docs/, generates content, and can install the docs dependencies for you.

Minimal config

{
  "source": {
    "type": "git",
    "repoUrl": "https://github.com/your-org/your-repo",
    "branch": "main"
  },
  "site": {
    "title": "Your Docs",
    "tagline": "Generated from README files.",
    "url": "https://your-org.github.io",
    "baseUrl": "/your-docs/",
    "organizationName": "your-org",
    "projectName": "your-docs",
    "repositoryUrl": "https://github.com/your-org/your-repo",
    "editUrl": "https://github.com/your-org/your-repo/tree/main",
    "defaultLocale": "en",
    "locales": ["en"],
    "navbar": {
      "docsLabel": "Docs",
      "repositoryLabel": "GitHub"
    }
  }
}

Commands

xiaoeyu init
xiaoeyu generate --config ./xiaoeyu.config.json
xiaoeyu print-docusaurus-config --config ./xiaoeyu.config.json
xiaoeyu scaffold-site --target ./docs

xiaoeyu init supports these flags:

xiaoeyu init --config ./xiaoeyu.config.json --target ./docs --yes --no-install

GitHub Action

Use the packaged action from the xiaoeyu directory:

- uses: your-org/your-xiaoeyu-repo/xiaoeyu@v1
  with:
    config: xiaoeyu.config.json