This repository builds the design system pages on the digital land site.

We recommend working in virtual environment before installing the python dependencies. Then run:

make init
make render

This will rebuild all the pages, putting them in the /docs directory.

Commit changes to this directory.

All documentation and examples are kept in the /documentation directory.

To add a new example, create a .html file in the component directory you are providing the example for. E.g. documentation/digital-land/buttons/example.html.

To update the documentation edit any of the markdown files found in documentation/. E.g. documentation/digital-land/components/info-text/README.md.

If you want to include an example add the following to your markdown:

{{ designSystemExample({
"iframe": {
    "title": "An example of the feedback panel component",
    "url": "example.html",
    "size": "s"
},
"example": {
    "path": "digital-land/components/example"
}
}) }}

Where url is the name of the example file, name is the name of the component directory and size is one of xs, s, m or l depending on the amount of size you want it to take up.

Remember to add the new component/documentation page to the component menu.

If a new component has been added digital land frontend you can add documentation for it by creating a directory for it in documentation/digital-land and then creating at least 1 example and a README.md file.

A new component should have a directory such as:

documentation/digital-land/new-component
    - example.html
    - example2.html
    - README.md