https://github.com/sparkbox/propulsion-docs

Documentation site for Propulsion
https://github.com/sparkbox/propulsion-docs

Last synced: 8 days ago
JSON representation

Documentation site for Propulsion

• Host: GitHub
• URL: https://github.com/sparkbox/propulsion-docs
• Owner: sparkbox
• Created: 2023-09-28T15:31:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-20T18:40:50.000Z (over 1 year ago)
• Last Synced: 2024-12-17T02:03:10.781Z (about 1 month ago)
• Language: SCSS
• Size: 318 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Propulsion Documentation Site

[![Netlify Status](https://api.netlify.com/api/v1/badges/a00db356-646d-4a6e-9dc5-f9901f700875/deploy-status)](https://app.netlify.com/sites/propulsion-docs/deploys)

This repository is for the Propulsion Design System Tool documentation site.

For the Propulsion repository, see [sparkbox/propulsion](https://github.com/sparkbox/propulsion).

## Getting Started

This docs site is built using [Eleventy](https://11ty.dev) and requires [Node.js](https://nodejs.dev).

1. Fork repo and pull to local

2. From a command prompt open the repo directory

3. Run `npm install` to install all Node-related dependencies

4. Run `npm start` to run the build and server at [localhost:8080](http://localhost:8080).

## Contributing

The Propulsion docs site is an open-source project and welcomes updates and edits as needed. All pull requests will be reviewed, accepted, and rejected by members of [Sparkbox](https://github.com/sparkbox)’s team.

Please review the issues list, or submit an issue if you find an error on the site, before contributing to the project.