Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/sourcey/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Sourcey Documentation

Sourcey is a CLI tool for scaffolding and managing static sites. This document covers the basic commands and workflow.

## Installation

```bash
npm install -g sourcey
```

## Quick Start

1. Initialize a new project:

```bash
npx sourcey init my-project
cd my-project
```

2. Build the site:

```bash
sourcey build
```

3. Preview locally (optional):

```bash
sourcey serve
```

4. Deploy to your hosting provider (e.g., Netlify, Vercel, or a custom domain):

```bash
sourcey deploy
```

## Configuration

Edit `sourcey.config.js` or `sourcey.yaml` in your project root to customize site metadata, themes, and plugins.

## Documentation & Help

- Official docs: [sourcey.com/docs](https://sourcey.com/docs)
- GitHub repository: [github.com/sourcey/sourcey](https://github.com/sourcey/sourcey)
- Report issues: [github.com/sourcey/sourcey/issues](https://github.com/sourcey/sourcey/issues)

## Examples

```bash
# Create a new project with a blog template
npx sourcey init my-blog --template blog

# Build for production
sourcey build --production
```

## License

Sourcey is open source and maintained under the MIT license.
33 changes: 33 additions & 0 deletions verify/09-check-sourcey-docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#!/usr/bin/env bash
# Usage: ./verify/09-check-sourcey-docs.sh [docs-path]
# Default docs-path is docs/sourcey/README.md
# Verifies that Sourcey documentation exists, contains required sections,
# and references the expected commands and links.
set -euo pipefail

DOCS="${1:-docs/sourcey/README.md}"

fail() { echo "FAIL: $1" >&2; exit 1; }

[ -f "$DOCS" ] || fail "Documentation file not found: $DOCS"

# Check required sections using grep
required=(
"npm install -g sourcey"
"npx sourcey init"
"sourcey build"
"sourcey.com/docs"
)

for pattern in "${required[@]}"; do
if ! grep -qiF "$pattern" "$DOCS"; then
fail "Missing required content: '$pattern'"
fi
done

# Check that the file is valid Markdown (basic: contains at least one heading)
if ! grep -qE '^#' "$DOCS"; then
fail "Documentation does not contain any Markdown headings"
fi

echo "PASS: Sourcey documentation exists, contains required commands and links"