Dokugen Docs

Everything you need to know about Dokugen, from installation to advanced usage.

Getting Started

1. Prerequisites

Ensure you have Node.js installed on your machine. If not, download and install it from nodejs.org.

Verify your Node.js installation by running:

node -v

2. Navigate to Your Project

Open your terminal and navigate to your project directory:

cd your-project

3. Install Dokugen Globally

Install Dokugen globally using npm:

npm install -g dokugen

4. Generate README

Run the following command to generate your README:

npx dokugen generate

5. Customize

Edit the generated README.md file to suit your project.

Features

Modern READMEs

Generate READMEs with emojis, badges, and modern formatting.

Cross-Platform

Works on any OS and programming language.

Easy Integration

Integrate with GitHub, GitLab, and VS Code.

FAQs

How do I install Dokugen?

Run npm install -g dokugen to install Dokugen globally.

Can I use custom templates?

Coming Soon, you will be able to use the --template flag flag to specify a custom template u can do something like: dokugen --template https://raw.githubusercontent.com/username/repo-name/blob/main/README.md.

Can I auto generate my readme using the --live flag?

Coming Soon, you will be able to use the --live flag flag to watch ad auto generate your readme in upcoming Dokugen version 3.6.0.

See Dokugen in Action

Loading metrics...

Need help? Check out our GitHub or support page.