Forrest logo
back to the mkdocs tool


mkdocs: Create a new mkdocs project.
$ mkdocs new ${project_name}
try on your machine

The command "mkdocs new ${project_name}" is used to create a new project in MkDocs, a static site generator tool commonly used for creating documentation websites.

In this command, "${project_name}" is a placeholder for the desired name of the project. You need to replace it with an actual name when running the command.

When executed, this command creates a new directory with the specified project name and initializes it as a new MkDocs project. Inside the directory, it creates a basic directory structure and configuration files needed to get started with building the project. This includes a "docs" directory for storing the documentation files (written in Markdown format by default) and a "mkdocs.yml" configuration file to customize how the documentation is generated and served.

After running this command, you can navigate into the project directory and start editing the documentation files in the "docs" directory. You can also modify the "mkdocs.yml" file to configure various aspects of the project, such as the site's theme, navigation, and other settings.

Overall, the "mkdocs new ${project_name}" command acts as a convenient way to quickly set up a new MkDocs project with the necessary files and directories to begin creating documentation.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the mkdocs tool