/co-design

Source files for the Weavly Co-Design website.

Primary LanguageSCSSBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Weavly Co-Design

Netlify Status

This repository contains the files needed to build Eleventy-based static sites for the Fluid Project. It does not include support for internationalization; if your project requires internationalization, use Trivet instead.

Usage

To run locally in development mode

  1. Install the required NPM packages: npm install
  2. Run Eleventy in development mode: npm start.

The website will be available at http://localhost:8080.

To build and serve using Docker

You can build and serve the website from a Docker container.

Once you have Docker installed, run the following commands to build a Docker image and start a container:

  • Build the image: docker build -t weavly-co-design .
  • Run the container: docker run --name weavly-co-design -p 8000:80 weavly-co-design

The website will be available at http://localhost:8000

If you make changes to the website, repeat the steps to build the image and start a new container.

To build for deployment to a personal web server

  1. Install the required NPM packages: npm install
  2. Run the build script: npm run build
  3. Upload the contents of the ./_site/ directory to the web root of your server.

If you make changes to the website, repeat step 2 to build the website and upload any changed files from the ./_site/ directory to the web root of your server.

Features

  • Basic static site configuration for developing project websites and blogs.
  • Starter configuration for Decap CMS.
  • Integrated User Interface Options Preferences Editor.

Notes

Modifications can be made to any source file or directory except for the contents of the _site directory. The _site directory is not versioned since it contains the built website that Eleventy generates from the source files, and files in _site are overwritten at build time.

Working with Decap CMS

The Decap CMS configuration can be edited in src/admin/config.yml. For full documentation, see the Decap CMS documentation.

License

The Weavly Co-Design is available under the New BSD License.

Third Party Software in the Weavly Co-Design

The Weavly Co-Design is based on other publicly available software, categorized by license:

New BSD License