Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 3.7 KB

README.md

File metadata and controls

88 lines (55 loc) · 3.7 KB
Raw

Trivet Monolingual

A simple starter kit for Eleventy-based static sites for the Fluid Project.

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.

Installation

You can use this repository as a template for a new site hosted on Netlify with Decap CMS pre-configured:

Deploy to Netlify

You can use GitHub's template repository feature to create your own project based on Trivet Monolingual. From the repository homepage, click the "Use this template" button and then choose "Create a new repository".

You can also set up a new project locally using degit:

npx degit fluid-project/trivet-monolingual YOUR-PROJECT-NAME

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 trivet-monolingual .
  • Run the container: docker run --name trivet-monolingual -p 8000:80 trivet-monolingual

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

Trivet Monolingual is available under the New BSD License.

Third Party Software in Trivet Monolingual

Trivet is based on other publicly available software, categorized by license:

MIT License