https://github.com/gravitydepartment/design-docs

Document your design system and pattern library using Markdown and PHP.
https://github.com/gravitydepartment/design-docs

design-system documentation markdown pattern-library php

Last synced: 13 days ago
JSON representation

Document your design system and pattern library using Markdown and PHP.

• Host: GitHub
• URL: https://github.com/gravitydepartment/design-docs
• Owner: gravitydepartment
• Created: 2018-02-08T04:29:19.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:07:21.000Z (about 2 years ago)
• Last Synced: 2024-09-14T23:33:37.183Z (4 months ago)
• Topics: design-system, documentation, markdown, pattern-library, php
• Language: JavaScript
• Homepage:
• Size: 1.26 MB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - gravitydepartment/design-docs - Document your design system and pattern library using Markdown and PHP. (JavaScript)

README

        
[![Gravity Department](https://cdn.gravitydept.com/github/repo-header.png)](https://gravitydept.com/)

# GravDept Design Docs

Document your design system and pattern library using Markdown in a small LAMP application.

## Dependencies

- PHP

- Apache

## Setup

### URL path

See the `.htaccess` file. The default configuration uses a directory like:

```

domain.com/design/

```

When using a subdomain, you can remove the directoy path from each `RewriteRule`.

### Configuration

See `config.php` and make changes for your environment.

## Build system

A Gulp-based build system generates the assets required by Design Docs. These can be committed once, and will rarely change unless you customize the Design Docs application.

## Usage

In the `content` folder, add folders and Markdown files.

## Issues

[Submit issues](https://github.com/gravitydepartment/design-docs/issues) on GitHub.