Skip to content

Commit e154149

Browse files
committed
Updated the package instructions to reflect the latest changes and the migration to npm from yarn
1 parent 332f9e5 commit e154149

3 files changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
# user-doc-template
22
A template repository for user-facing documentation of hardware
3+
4+
See the latest instructions for how to use this package at: [https://devices-lab.github.io/user-doc-template/](https://devices-lab.github.io/user-doc-template/)

eleventy.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import file from "node:fs";
33

44
export default async function (eleventyConfig, options = {}) {
55
// Register user-doc-base plugin with this project's input dir
6-
await userDocBase(eleventyConfig, { inputDir: "src", syncChanges: true });
6+
await userDocBase(eleventyConfig, { inputDir: "src", syncChanges: false });
77

88
eleventyConfig.addPassthroughCopy("**/*.png");
99
eleventyConfig.addPassthroughCopy("**/*.jpg");

src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: "devices-lab/default"
3-
image: img/pexels-abdellah-benziane-2153835967-36053909.jpg
3+
image: https://placecats.com/400/400/
44
---
55

66
# Overview
@@ -13,11 +13,11 @@ We use the excellent [eleventy (11ty)](https://www.11ty.dev/) to build the stati
1313

1414
## Writing Documentation
1515

16-
Ensure you have both `node` (nodejs) and `yarn` installed.
16+
Ensure you have both `node` (nodejs) and `npm` installed.
1717

18-
To run the development server, which live updates your pages and serves a local development host, launch `yarn run dev:11ty`.
18+
To run the development server, which live updates your pages and serves a local development host, launch `npm run dev:11ty`.
1919

20-
Alternatively, to run a single one-shot build, run `yarn run build`.
20+
Alternatively, to run a single one-shot build, run `npm run build`.
2121

2222
In both cases, the complete output will be available in the `_site/` subdirectory.
2323

0 commit comments

Comments
 (0)