https://github.com/jadu/pulsar-documentation

Documentation for the Pulsar design system, from Jadu.
https://github.com/jadu/pulsar-documentation

Last synced: 5 days ago
JSON representation

Documentation for the Pulsar design system, from Jadu.

• Host: GitHub
• URL: https://github.com/jadu/pulsar-documentation
• Owner: jadu
• Created: 2018-11-07T09:41:03.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2022-12-07T08:32:43.000Z (almost 2 years ago)
• Last Synced: 2024-04-16T00:49:48.914Z (7 months ago)
• Language: Twig
• Size: 97.8 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This project is no longer maintained, documentation has moved into the main jadu/pulsar repository and published at https://jadu.github.io/pulsar

----

# Pulsar documentation

## Running locally

Documentation can run locally within a Docker container, all documentation authoring should take place locally, and be peer-reviewed before publishing to the live server.

You will need:

* A local checkout of the pulsar-documentation GitHub project

* [Docker Desktop](https://www.docker.com/products/docker-desktop) installed

* To run `composer install` if this is your first time

From your local checkout, run the following command:

```

npm start

```

The local documentation should then be accessible by visiting http://localhost:5000 in your browser. Any changes you make to your local checkout will be reflected there without the need to clear cache, however some assets (like JavaScript and Sass/CSS may take a few seconds to rebuild).

The docker container can also be stopped using the `npm stop` command.

## Publishing to live

Documentation for this process is interal-only, and available on request from Paul Stanton or James Jacobs.