Skip to content

README.md

Latest commit

 

History

History
38 lines (26 loc) · 1.31 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.31 KB
Raw

This project contains the content for the website at tactilityproject.org.

The pages are markdown files in docs/. Eleventy turns them into static HTML.

Install the dependencies (Node.js 20 or newer):

npm install

Develop with a local server that reloads on changes:

npm start

Build the site into _site/:

npm run build

Where things are

  • docs/*.md: the pages. docs/index.md is the home page; its hero, screenshots and supporter logos are listed in the frontmatter.
  • docs/devices/*.md: one page per device. The Supported Devices list is generated from the frontmatter of these files, see DEVICE_TEMPLATE.md.
  • docs/_data/: site name, community links and navigation.
  • docs/_includes/: page layouts.
  • docs/assets/site.css: the stylesheet.

Markdown extras

  • Alerts: > [!NOTE] and > [!WARNING] blocks.
  • Tabbed card: wrap ::: tab <Title> blocks in :::: tabs ... :::: (see docs/installing.md).
  • Option cards with a button at the top of a page: options: in the frontmatter (see docs/installing.md).
  • A paragraph of linked images is shown as a row of logos (see docs/community.md).

Pushing to main builds and publishes the site with GitHub Actions (.github/workflows/deploy.yml).