Skip to content

splintercommunity/grid-docs

Repository files navigation

Grid

grid-docs

The grid-docs repository contains source code and assets for the Grid Docs website.

Building the Website Locally

This repository includes a docker-compose file that builds and runs the website in a Docker container.

Prerequisites: Docker Engine and Docker Compose must be installed and running.

  1. Create a local clone of the grid-docs repository.

  2. Change to the root directory of your local clone, then run the following command:

    docker-compose up
    
  3. When this command finishes, the site will be available at http://localhost:8080.

To stop the Docker container, enter [Ctrl]+C in the same terminal window where you ran docker-compose up, then run this command:

docker-compose down -v

Website Content

The content for the website's pages (Home, About, Community, etc.) is written in Markdown.

License

The Grid website and the content in this repository are covered by the Creative Commons Attribution 4.0 International license (CC BY 4.0) unless otherwise noted.

Portions of the Grid website are generated with Jekyll, which is used under the MIT license.

Website generation includes the Markdown lint tool, which is used under the MIT license.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •