getting-started.md

title	layout	seo-title	description	keywords	path_slug	category
getting started	default	Getting Started	Getting up and running locally with this documentation site.	contributing	getting-started	documentation

{{page.title}}

{{ page.description }}

This page will walk you through how to set up this documentation site locally and contribute to it moving forward. If you'd like to contribute to a component please read through our contributing guidelines.

Dependencies

.editorconfig Plugin - The .editorconfig file ensures that everyone contributing to the project will use the same indentation.

Structure

components/
├── component-name/
│   ├── content
│       ├── _code.md
│       ├── _documentation.md
│       ├── _examples.md
│       ├── _notes.md
│       ├── _resources.md
│       ├── _support.md
│   ├── component-usage.js (optional)
│   ├── component-wp.html (optional)
│   ├── component.css (optional)
│   ├── component.html
│   ├── example.html
│   ├── index.md
.editorconfig
.gitignore
.jscsrc
.jshintrc
components.md
CONTRIBUTING.md
Gemfile
getting-started.md
index.md
LICENSE.md
README.md

Running Locally

gem install bundler
bundle install
bundle exec jekyll serve

Once bundle exec jekyll serve has run, you can view the 10up Component library in your browser by copying/pasting the server address from your command line. It will look similar to the code below.

Configuration file: /[your-path-to-project]/wp-component-library/_config.yml
Server address: http://127.0.0.1:4000/wp-component-library/
Server running... press ctrl-c to stop.

Check out GitHub's documentation on local Jekyll setup for more info.