/doc-starter

Start your new documentation project by forking this repository.

Primary LanguageRuby

Magento store design documentation

Documenting the PWA components and design patterns. Collection of resources for learning how to design a customized Magento storefront.

Prerequisites

  • Ruby

Setup

  1. Install project dependencies

bunlde install

  1. Start dev server. This server watches for changes in the src directory and updates using browser-sync.
cd src
bundle exec jekyll serve

Directories

src

: Source of Jekyll assets. All doc related work should be done in here.

_site

: Directory where jekyll creates the HTML files.

Files

Gemfile

: Ruby gems used in the project.

_config.production.yml

: Production-specific configurations.