Skip to content

Repository files navigation

Mkdirs Docs

Mkdirs Docs

The bilingual documentation for Mkdirs, powered by FumaPress and deployed on Cloudflare Workers.

License GitHub stars FumaPress Cloudflare Workers TypeScript

Documentation · Website · Report a Bug

Mkdirs Docs screenshot

Features

  • Content-first documentation with Markdown and MDX
  • Static search with keyboard shortcuts
  • Responsive navigation, table of contents, and light/dark/system themes
  • Locale-aware routing with a customizable language switcher
  • Reusable cards, callouts, steps, tabs, accordions, file trees, type tables, Lucide icons, and video embeds
  • Per-page Markdown, llms.txt, a homepage Open Graph image, generated per-page Open Graph images, and sitemap generation
  • Static deployment to Cloudflare Workers with Wrangler
  • No Worker runtime code or application bindings required

Tech stack

Getting started

Prerequisites

  • Node.js 20.19 or later
  • pnpm

Installation

git clone https://github.com/MkdirsHQ/mkdirs-docs.git
cd mkdirs-docs
pnpm install
pnpm dev

Open the local URL printed in the terminal.

Commands

Command Description
pnpm dev Start the local development server
pnpm build Generate the production-ready static site
pnpm check Run source generation, TypeScript, build, and Wrangler dry-run checks
pnpm deploy Build and deploy the site with Wrangler

Deploy to Cloudflare Workers

  1. Authenticate Wrangler:

    pnpm exec wrangler login
  2. Update the Worker name and optional custom domain in wrangler.jsonc.

  3. Validate and deploy:

    pnpm check
    pnpm deploy

For CI deployments, provide CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID as secrets.

Contributing

Contributions are welcome.

  1. Fork the repository.
  2. Create a branch for your change.
  3. Run pnpm check before committing.
  4. Open a pull request with a clear description of the change.

For bugs and feature requests, please open an issue.

Author

OpenFox is an independent developer building products and developer tools. His products include:

  • TanStarter — Ship Faster with TanStack, Cost Less with Cloudflare.
  • MkSaaS — Make Your AI SaaS Product in a Weekend.
  • MkImage — Make Any Images Possible.
  • MkDirs — Launch AI-powered directory in 30 minutes.
  • MkDollar — The all-in-one platform to help you make first dollar online.

License

Licensed under the MIT License.