Getting Started with docmd
Getting Started Overview
Welcome to docmd
! This section will guide you through installing docmd
, initializing your first documentation project, and understanding the basic commands to build and preview your site.
Whether you’re documenting a new open-source project, an internal tool, or just want a simple way to publish Markdown content as a website, docmd
aims to make the process straightforward and enjoyable.
What You’ll Learn:
- Installation: How to install
docmd
on your system using npm. - Basic Usage:
- Initializing a new
docmd
project withdocmd init
. - Adding and structuring your Markdown content.
- Building your static site with
docmd build
. - Previewing your site with live reloading using
docmd dev
.
- Initializing a new
Ready to begin? Let’s start with Installation.