Skip to content

DocuBook/docubook

Repository files navigation

DocuBook

DocuBook is a documentation web project designed to provide a simple and user-friendly interface for accessing various types of documentation. This site is crafted for developers and teams who need quick access to references, guides, and essential documents.

Features

  • Easy Navigation: Simple layout for quick navigation between pages.
  • Quick Search: Easily find documentation using a search function.
  • Responsive Theme: Responsive design optimized for devices ranging from desktops to mobile.
  • Markdown Content: Support for markdown-based documents.
  • SEO Friendly: Optimized structure for search visibility, enhancing accessibility on search engines.

Installation

npx @docubook/cli@latest

command output

command output

Contributing

Note

Please read: CONTRIBUTING.md

Workspace

Important

This repository uses a monorepo setup powered by pnpm workspaces and Turborepo to manage apps and packages in a single workspace.

For development workflow:

  • Changesets handles package versioning and release management
  • Husky runs automatic linting and formatting before commits
  • commitlint ensures commit messages follow the Conventional Commits format consistently

This setup helps keep the codebase organized, maintainable, and contributor-friendly.

About

DocuBook is a modern documentation platform for building, deploying, and managing your docs with ease.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors