{"id":51404848,"url":"https://github.com/darmie/markflow","last_synced_at":"2026-07-04T10:02:14.566Z","repository":{"id":340362504,"uuid":"1165700109","full_name":"darmie/markflow","owner":"darmie","description":"Turn Markdown files into beautiful, step-by-step tutorial pages — inspired by Google Codelabs.","archived":false,"fork":false,"pushed_at":"2026-03-01T08:55:54.000Z","size":342,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-07-01T12:33:29.948Z","etag":null,"topics":["cli","docs","documentation","documentation-generator","documentation-tool","markdown"],"latest_commit_sha":null,"homepage":"https://markflow.page/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/darmie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-24T12:59:25.000Z","updated_at":"2026-03-02T17:31:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/darmie/markflow","commit_stats":null,"previous_names":["darmie/markflow"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/darmie/markflow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darmie%2Fmarkflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darmie%2Fmarkflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darmie%2Fmarkflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darmie%2Fmarkflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darmie","download_url":"https://codeload.github.com/darmie/markflow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darmie%2Fmarkflow/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35117336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-04T02:00:05.987Z","response_time":113,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","docs","documentation","documentation-generator","documentation-tool","markdown"],"created_at":"2026-07-04T10:02:13.615Z","updated_at":"2026-07-04T10:02:14.560Z","avatar_url":"https://github.com/darmie.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markflow\n\nTurn Markdown files into beautiful, step-by-step tutorial pages — inspired by Google Codelabs.\n\n![Markflow Screenshot](.github/screenshot.png)\n\n## Features\n\n- **Zero dependencies** — Bash CLI, single-file HTML output\n- **GitHub-native** — fetches Markdown from any repo, supports branch/tag switching\n- **Pre-baking** — embed content at build time for instant loads and offline use\n- **Theming** — 14 CSS variables for full color customization\n- **Social links** — GitHub, Twitter/X, Discord, LinkedIn, YouTube, website icons\n- **Giscus comments** — GitHub Discussions-powered comments on every page\n- **LLM-friendly** — generates `llms.txt` and `api.json` for AI agent consumption\n- **Responsive** — desktop, tablet, and mobile layouts\n\n## Quick Start\n\n**Install:**\n\n```bash\ncurl -sL https://raw.githubusercontent.com/darmie/markflow/main/install.sh | bash\n```\n\n**Initialize:**\n\n```bash\nmarkflow init\n```\n\nEdit the generated `.env` with your repo details:\n\n```env\nMARKFLOW_REPO_OWNER=your-org\nMARKFLOW_REPO_NAME=your-repo\nMARKFLOW_REPO_ROOT=docs\nMARKFLOW_BRAND_NAME=My Docs\n```\n\n**Build:**\n\n```bash\nmarkflow build --prebake --source ./docs\n```\n\n**Preview:**\n\n```bash\nmarkflow serve\n# Open http://localhost:3000\n```\n\n## Writing Docs\n\nCreate `.md` files in your docs directory. Markflow uses your heading structure for navigation:\n\n- `# H1` — page title\n- `## H2` — numbered steps in the sidebar\n- `### H3` / `#### H4` — sub-items under the active step\n\nFiles are sorted alphabetically — use numeric prefixes to control order:\n\n```\ndocs/\n├── 01-introduction.md\n├── 02-getting-started.md\n└── 03-reference.md\n```\n\n## CLI Usage\n\n| Command | Description |\n|---------|-------------|\n| `markflow init` | Create `.env` config file |\n| `markflow build` | Generate `index.html` |\n| `markflow build --prebake --source ./docs` | Build with embedded content |\n| `markflow build --output ./public` | Custom output directory |\n| `markflow build --config ./custom.env` | Use custom config file |\n| `markflow serve` | Preview at `localhost:3000` |\n| `markflow serve --port 8080` | Preview on custom port |\n| `markflow build --serve` | Build and preview in one step |\n\n## Deploy to GitHub Pages\n\nCreate `.github/workflows/deploy-docs.yml`:\n\n```yaml\nname: Deploy Docs\n\non:\n  push:\n    branches: [main]\n\npermissions:\n  contents: read\n  pages: write\n  id-token: write\n\nconcurrency:\n  group: pages\n  cancel-in-progress: true\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    environment:\n      name: github-pages\n      url: ${{ steps.deployment.outputs.page_url }}\n    steps:\n      - uses: actions/checkout@v4\n\n      - name: Build docs\n        run: |\n          chmod +x ./markflow\n          ./markflow build --prebake --source ./docs --output ./site --config ./docs/.env\n\n      - uses: actions/configure-pages@v5\n\n      - uses: actions/upload-pages-artifact@v3\n        with:\n          path: ./site\n\n      - id: deployment\n        uses: actions/deploy-pages@v4\n```\n\nEnable GitHub Pages in **Settings \u003e Pages \u003e Source: GitHub Actions**, then push to `main`.\n\n## Configuration\n\nAll options are set in `.env`. Run `markflow init` to generate a template.\n\n| Variable | Default | Description |\n|----------|---------|-------------|\n| `MARKFLOW_REPO_OWNER` | — | GitHub owner (required) |\n| `MARKFLOW_REPO_NAME` | — | Repository name (required) |\n| `MARKFLOW_REPO_BRANCH` | `main` | Default branch |\n| `MARKFLOW_REPO_ROOT` | — | Subdirectory for docs |\n| `MARKFLOW_BRANCH_SWITCHER` | `true` | Show branch/tag dropdown |\n| `MARKFLOW_BRAND_NAME` | `My Docs` | Header title |\n| `MARKFLOW_BRAND_LOGO` | — | SVG file, URL, or inline SVG |\n| `MARKFLOW_ACCENT` | `#c4956a` | Primary accent color |\n| `MARKFLOW_GISCUS_REPO` | — | Enable Giscus comments |\n| `MARKFLOW_LLM_FRIENDLY` | `true`* | Generate `llms.txt`, `llms-full.txt`, `api.json` |\n\n\\* Defaults to `true` for pre-baked builds with `--source`.\n\n### LLM-Friendly Output\n\nWhen building with `--source`, Markflow generates machine-readable files alongside `index.html`:\n\n| File | Purpose |\n|------|---------|\n| `llms.txt` | Summary index following the [llms.txt standard](https://llmstxt.org/) |\n| `llms-full.txt` | All pages concatenated as markdown |\n| `api.json` | Structured JSON with page metadata, sections, and content |\n\nThese let AI agents and LLM tools discover and digest your documentation without rendering JavaScript. Set `MARKFLOW_LLM_FRIENDLY=false` to disable.\n\nSee [full documentation](https://markflow.page/) for all theme colors and social link options.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarmie%2Fmarkflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarmie%2Fmarkflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarmie%2Fmarkflow/lists"}