https://github.com/docmd-io/docmd-template
The fastest way to start a documentation site with docmd. Pre-configured and ready to deploy.
https://github.com/docmd-io/docmd-template
analytics demo deploy docmd documentation sample seo static-site-generator template website
Last synced: 1 day ago
JSON representation
The fastest way to start a documentation site with docmd. Pre-configured and ready to deploy.
- Host: GitHub
- URL: https://github.com/docmd-io/docmd-template
- Owner: docmd-io
- License: mit
- Created: 2026-06-08T18:43:27.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-06-10T07:43:55.000Z (30 days ago)
- Last Synced: 2026-06-29T11:31:25.284Z (11 days ago)
- Topics: analytics, demo, deploy, docmd, documentation, sample, seo, static-site-generator, template, website
- Homepage: https://docmd-io.github.io/docmd-template
- Size: 9.77 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create Repo with docmd · GitHub Templates
[](https://github.com/docmd-io/docmd-template/generate)
The fastest way to start a documentation site with [docmd](https://github.com/docmd-io/docmd) — pre-configured and ready to deploy.
## Get started
1. Click **[Use this template](https://github.com/docmd-io/docmd-template/generate)** and create your repository
2. Update `docmd.config.json` with your site title and URL
3. Push to `main` — your site deploys automatically
> Your site will be live at `https://.github.io//`
## What's included
```
.github/workflows/docs.yml # Auto-deploy on push to main
docmd.config.json # Site title, URL, and output directory
docs/index.md # Your first page
package.json # Local dev scripts
```
## Local development
```bash
npm install
npm run dev # Live preview at localhost:3000
npm run build # Build to site/
```
## First-time setup
GitHub Pages must be set to deploy from **GitHub Actions** (not a branch).
Go to **Settings → Pages → Source → GitHub Actions**.
This only needs to be configured once per repository.
#### [Website](https://docmd.io) • [Documentation](https://docs.docmd.io) • [MIT License](LICENSE)