DocPad
Search…
DocPad
Start
Install
Overview
Beginners Guide
Deploy
FAQ
Troubleshoot
Support
Upgrade
Performance
Core
API
Command Line Interface
Configuration
Events
Meta Data
Sequence Flow
Template Data & Helpers
Extend
Extending
Write a Plugin
Community
Contribute
Participate
Plugins
Showcase
Roadmap
Powered By
GitBook
Command Line Interface
To discover what commands are available:
1
docpad --help
Copied!
To create your website (if it doesn't already exist), watch for changes, and start the webserver, use:
1
docpad run
Copied!
To just generate your website from one of the existing skeletons, use:
1
docpad scaffold
Copied!
To just generate your compiled website, use:
1
docpad generate
Copied!
To just watch your website for changes and re-generate whenever a change is made, use:
1
docpad watch
Copied!
To just run the DocPad server to access your already generated website, use:
1
docpad server
Copied!
To render standalone files with DocPad programmatically (will output to stdout)
1
docpad render filePath
Copied!
For example, to render a markdown file and save the result to an output file, we would use:
1
docpad render inputMarkdownFile.html.md
>
outputMarkdownFile.html
Copied!
To render stdin with DocPad programmatically (will output to stdout)
1
echo
$content
|
docpad render sampleFileNameWithExtensions
Copied!
For example, to render passed markdown content and save the result to a file, we would use:
1
echo
"**awesome**"
|
docpad render input.html.md
>
output.html
Copied!
Core - Previous
API
Next - Core
Configuration
Last modified
3yr ago
Copy link