Skip to content

docs: Add FAQ section for common questions #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
meichuanyi wants to merge 1 commit into
base: main
Choose a base branch
from
+53 −0
Open

docs: Add FAQ section for common questions #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,3 +505,56 @@ If the curve bends up, that's the signal we look for. ★ this repo to push it.
Apache-2.0 © 2026 HTML Anything contributors. See [`LICENSE`](LICENSE).

Bundled work retains its original license and authorship attribution — see the per-skill `LICENSE` / `README.md` inside each `next/src/lib/templates/skills/<skill>/` folder for what it inherits from upstream.


## FAQ

### What is HTML Anything?

HTML Anything is the agentic HTML editor — your local AI agent writes HTML for you. It combines the power of AI agents with HTML editing to create websites, components, and layouts automatically.

| Feature | Description |
|---------|-------------|
| **AI Agent Editor** | AI writes HTML based on your descriptions |
| **Local Execution** | Runs on your machine, no cloud needed |
| **Real-time Preview** | See changes instantly |
| **Component Library** | Pre-built HTML templates |
| **Custom Styling** | Tailwind CSS, custom CSS support |
| **Export Options** | Download HTML, deploy to hosting |

### Getting Started

```sh
# Clone and run
git clone https://github.com/nexu-io/html-anything
cd html-anything
npm install
npm start
Comment on lines +527 to +532

@nettee nettee May 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new Getting Started snippet is not runnable for this repo as written. At the workspace root there is no npm start script (package.json only declares the workspace metadata), and the repo guidance above already uses pnpm -F @html-anything/next dev for local startup. As a result, someone following this FAQ will hit a dead end immediately. Please replace this block with the real root-level bootstrap commands for this workspace, e.g. pnpm install --frozen-lockfile followed by pnpm -F @html-anything/next dev.

🔁 Powered by Looper · runner=reviewer · agent=opencode · An autonomous AI dev team for your GitHub repos.

```

### Key Concepts

| Concept | Description |
|---------|-------------|
| **Agent Loop** | AI iteratively improves HTML based on feedback |
| **Component System** | Modular HTML blocks for reuse |
| **Preview Engine** | Live rendering of generated HTML |
| **Export Pipeline** | One-click download or deployment |

### Supported Use Cases

- **Quick Prototyping** — Generate HTML layouts in seconds
- **Component Creation** — AI builds reusable HTML components
- **Website Drafting** — Start from description, refine with AI
- **Learning HTML** — See how AI structures HTML code
- **Template Generation** — Create starter templates for projects

### License

MIT License.

@nettee nettee May 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This FAQ entry changes the documented license from Apache-2.0 to MIT, which conflicts with the existing license badge, the root package.json, and the main ## License section directly above. Because license text is public-facing project metadata, publishing the wrong one can mislead downstream users about their rights and obligations. Please update this answer to match the repo’s actual Apache-2.0 license instead of introducing a second, conflicting license statement.

🔁 Powered by Looper · runner=reviewer · agent=opencode · An autonomous AI dev team for your GitHub repos.


### Help & Resources

- [Documentation](https://github.com/nexu-io/html-anything#readme)
- [Issues](https://github.com/nexu-io/html-anything/issues)
- [Examples](https://github.com/nexu-io/html-anything/tree/main/examples)

@nettee nettee May 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new Examples link points to tree/main/examples, but this repository does not have a top-level examples/ directory. That leaves the FAQ with a dead resource link in the same section that is supposed to help new users orient themselves. Please either remove this item or retarget it to an existing examples surface, such as the template/example files already under next/src/lib/templates/skills/**/example.html.

🔁 Powered by Looper · runner=reviewer · agent=opencode · An autonomous AI dev team for your GitHub repos.