Skip to content
girok-md

Quick Start

Get your blog up and running in just a few minutes.

Run Locally

Prerequisites

  • Node.js v20 or higher
  • Git
  • A folder with markdown files (e.g., Obsidian vault)

  1. Create your repository

    Click the Use this template button on the girok-md repository to create your own repository.

  2. Clone and install dependencies

    Terminal window
    git clone https://github.com/YOUR_USERNAME/YOUR_REPO.git
    cd YOUR_REPO
    npm install

  3. Configure your blog

    Edit the setting.toml file:

    setting.toml
    # Absolute path to your markdown files
    source_root_path = "/path/to/your/obsidian/vault"
    

    # Blog name
    blog_name = "My Blog"
    

    # Site URL (for SEO)
    site_url = "https://your-username.github.io"
    

    # Locale (en or ko)
    locale = "en"

  4. Sync your posts

    Terminal window
    npm run sync

    This command scans your markdown folder and copies files with publish: true in their frontmatter.

  5. Start the development server

    Terminal window
    npm run dev

    Visit http://localhost:4321 to see your blog!

Quick Start with Docker

Prerequisites

Prefer Docker? You can run girok-md with Docker Compose in 4 steps.

  1. Clone the repository

    Terminal window
    git clone https://github.com/7loro/girok-md.git
    cd girok-md

  2. Prepare a test markdown file

    Create a markdown file with publish: true frontmatter in any folder:

    Terminal window
    mkdir -p ~/my-posts
    cat > ~/my-posts/hello.md << 'EOF'
    ---
    title: Hello World
    publish: true
    ---
    

    My first blog post!
    EOF

  3. Update the volume path in docker-compose.yml

    Replace /path/to/your/markdown-folder with your actual markdown folder path:

    docker-compose.yml
    volumes:
      # Example: ~/my-posts, /Users/me/ObsidianVault, etc.
      - ~/my-posts:/source:ro
      - ./setting.toml:/app/setting.toml:ro

  4. Start with Docker Compose

    Terminal window
    docker compose up -d

    Visit http://localhost:8080 to see your blog!

Next Steps