What You'll Learn#
Prerequisites#
Before you begin, ensure you have the following tools installed:
- Node.js: Version 14.x or higher
- npm: Version 6.x or higher
- Git: Version 2.x or higher
Setup Steps#
Open your terminal and run the following command to install the DocuCraft command-line interface (CLI):
npm install -g docucraft-cliNavigate to the directory where you want to create your documentation site and run:
docucraft create my-docsReplace my-docs with your desired project name.
Change into your new project directory:
cd my-docsRun the following command to start the local development server:
docucraft startYour documentation site will be accessible at http://localhost:3000.
Open the docs folder in your favorite text editor. You can start editing the markdown files to add your content. The main file to edit is index.md.
As you make changes to your markdown files, the development server will automatically reload. You can see your updates in real-time by refreshing your browser.
Once you are satisfied with your documentation, deploy it using the following command:
docucraft deployFollow the prompts to complete the deployment process.
Next Steps#
Now that you have your DocuCraft documentation site set up, explore more about how to customize and enhance your site.
- Concepts — Understand the core concepts of DocuCraft.
- Quick Start Guide — Dive deeper into advanced features and best practices.
Start building your documentation site today and enhance collaboration with your team.
Start for free · Explore features