getting started

Getting up and running locally with this documentation site.

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.


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


├── component-name/
│   ├── content
│       ├──
│       ├──
│       ├──
│       ├──
│       ├──
│       ├──
│   ├── component-usage.js (optional)
│   ├── component-wp.html (optional)
│   ├── component.css (optional)
│   ├── component.html
│   ├── example.html
│   ├──

Running Locally

Navigate to the docs directory from the command line.

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:
Server running... press ctrl-c to stop.

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