CLI tool to scaffold standardized documentation structure for projects.
npm install scaffold-doc-cliA CLI tool to scaffold standardized documentation structure for Motin projects, ready for AI completion.
- š Initializes .docs/ directory with standardized structure.
- š§ Supports multiple stacks (Nuxt, Node, Python, etc.).
- š¤ Embeds AI-friendly context and instructions in Markdown comments.
- š¦ Optional GitHub Workflow for automated AI documentation updates.
You can use the tool directly with npx without installing it globally:
``bash`
npx scaffold-doc-cli
Or install it globally:
`bash`
npm install -g scaffold-doc-cli
init-doc
1. Clone the repository.
2. Install dependencies:
`bash`
npm install
`
3. Link the package globally:
bash`
npm link
`
4. Navigate to your target project folder:
bash`
cd ../my-project
`
5. Run the initialization command:
bash`
init-doc
```
my-project/
āāā .docs/
ā āāā index.md # Entry point with AI context
ā āāā components.md # Stack-specific (e.g., for Nuxt)
āāā .github/
āāā workflows/
āāā ai-doc-sync.yml # (Optional) Workflow file