docublitz

Docublitz

A Docusaurus site generator that allows you to generate a ready-made, deployable site in minutes. Check out the showcase for examples.

Prerequisites

• GitHub repository
• StackBlitz project

Getting started

Run npx docublitz to create a new Docusaurus site and follow the prompts.

CLI Options

Option	Description	Default
--embed.view	The initial view of the StackBlitz embed: default, editor, preview	default
--favicon	URL or path to favicon.
--installCommand	Command to install the package.
--githubOwner	Your project's GitHub org/user name.
--githubRepo	Your project's GitHub repository name.
--logo	URL or path to logo.
--name	Name of directory to create for the site.	website
--primaryColorDark	Primary hex color for dark mode.
--primaryColorLight	Primary hex color for light mode.
--stackBlitzId	The id of a StackBlitz project to embed.
--subheading	A subheading to display under the tagline.
--tagline	A tagline/heading to display on the home page hero section.

Showcase

• ngx-contentful-rich-text
• stripe-event-types

Roadmap

• GitHub Action to generate and deploy site to GitHub Pages
• Including a "docs" directory in generated site if exists in your project's repository