Skip to content

Commit 835b27b

Browse files
committed
fix TODOs
1 parent 2a25749 commit 835b27b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,19 +50,19 @@ Inside the `src` directory are:
5050
* `css`: Contains all the CSS. `site.css` contains imports of all the other files. In `vendor` there is the copied-in FontAwesome CSS file.
5151
* `helpers`: Contains Handlebars helper functions. The file names are the names of the helpers. You can use these inside the Handlebars templates.
5252
* `img`: Images used in the UI.
53-
* `js`: TODO
54-
* `layouts`: TODO
53+
* `js`: Contains JavaScript files for UI functionality, numbered for loading order. The `vendor` directory contains third-party libraries like highlight.js and tabs functionality.
54+
* `layouts`: Contains the main Handlebars layout templates. `default.hbs` is the standard page layout, `landing.hbs` is for landing pages with special styling, and `404.hbs` handles error pages. These templates define the overall page structure and include partials for header, body, and footer.
5555
* `partials`: Contains all the Handlebars files. This is the directory containing all the templated HTML for the site.
5656

5757
=== Gulp
5858

59-
To work on the build process of this, you need to understand [gulp](https://gulpjs.com/docs/en/getting-started/javascript-and-gulpfiles).
59+
To work on the build process of this, you need to understand https://gulpjs.com/docs/en/getting-started/javascript-and-gulpfiles[gulp].
6060
Gulp is a builder/bundler that is used to package this antora UI.
6161

6262
In this project, `gulpfile.js` is the main entrypoint for gulp.
6363
This file references tasks in the `gulp.d` directory.
6464

65-
You don't need to install the `gulp` CLI yourself, you can call package scripts (i.e. `npm run bundle` which will then call `gulp` from the `node_modules`)
65+
You don't need to install the `gulp` CLI yourself, you can call package scripts (i.e. `npm run bundle` which will then call `gulp` from the `node_modules`).
6666

6767
=== Building the final documentation
6868

0 commit comments

Comments
 (0)