Skip to content

docs: update README to match current docs and features#121

Merged
easylogic merged 1 commit into
mainfrom
docs/update-readme
Mar 9, 2026
Merged

docs: update README to match current docs and features#121
easylogic merged 1 commit into
mainfrom
docs/update-readme

Conversation

@easylogic

Copy link
Copy Markdown
Contributor

Updates README.md so it reflects the current documentation and feature set.

Summary of changes

  • Intro: Quick mode vs Full custom mode; link to docs
  • Features: sections, tabs, blog/changelog, API reference, standalone pages, overrides, convenience (edit link, last updated, feedback, announcement, contributors)
  • Quick Start: Node 20+, pnpm; pnpm create barodoc and barodoc create; [dir] auto-detect
  • Project structure: optional dirs (sections, pages, blog, changelog)
  • CLI: added check, manifest, init, eject; options table (port, config, output, clean, fix)
  • Configuration: tabs, sections, theme (accent/gray/fonts/radius), lineNumbers, editLink, lastUpdated, topbar, search, announcement, feedback, site, base, customCss
  • Content types: table (Docs, Blog, Changelog, API Reference, Standalone pages)
  • Plugins: overview table + usage guides per plugin with install/config examples (sitemap, search, analytics, openapi, rss, pwa, og-image, llms-txt, docsearch, raw-md)
  • Overrides subsection; Full Custom note (config path, src/content/docs/)
  • Packages table update

Closes #120

Made with Cursor

- Expand intro (Quick vs Full custom), add doc link and features
- Quick Start: Node 20+, pnpm, both create commands, [dir] auto-detect
- Project structure: optional dirs (sections, pages, blog, changelog)
- CLI: check, manifest, init, eject + options table
- Config: tabs, sections, theme, lineNumbers, editLink, lastUpdated, topbar, search, announcement, feedback, site, base, customCss
- Content types table; Plugins overview + per-plugin usage guides with examples
- Overrides and Full Custom notes; Packages table update

Ref: #120
Made-with: Cursor
@easylogic easylogic merged commit 26ff86b into main Mar 9, 2026
1 check failed
@easylogic easylogic deleted the docs/update-readme branch March 9, 2026 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README.md to match current docs and features

1 participant