Skip to content

Commit d05331a

Browse files
committed
refactor: build site with Eleventy
1 parent 5d78d90 commit d05331a

File tree

211 files changed

+3522
-12658
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

211 files changed

+3522
-12658
lines changed

.editorconfig

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[*]
2+
charset = utf-8
3+
insert_final_newline = true
4+
trim_trailing_whitespace = true
5+
6+
[{**/*.cjs, **/*.css,**/*.js,*.json,**/*.less,**/*.mjs,**/*.njk,**/*.scss,**/*.yaml}]
7+
indent_style = space
8+
indent_size = 2
File renamed without changes.

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ node_modules
66
.coverage/
77
.parcel-cache/
88
.vscode/
9+
_site/
910
coverage/
1011

1112
# Dotfile detritus
File renamed without changes.

content/en/about-block-inline-tags.md renamed to content/about-block-inline-tags.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Block and inline tags
3-
description: Overview of block and inline JSDoc tags.
3+
tags: gettingStarted
44
---
55

66
## Overview
@@ -30,7 +30,7 @@ Most JSDoc tags are block tags. In general, when this site refers to "JSDoc tags
3030

3131
In the following example, `@param` is a block tag, and `{@link}` is an inline tag:
3232

33-
{% example "Block and inline tags in JSDoc comments" %}
33+
::: example "Block and inline tags in JSDoc comments"
3434

3535
```js
3636
/**
@@ -42,11 +42,11 @@ Shoe.prototype.setColor = function(color) {
4242
// ...
4343
};
4444
```
45-
{% endexample %}
45+
:::
4646

4747
You can use inline tags within a description, as shown above, or within a block tag, as shown below:
4848

49-
{% example "Inline tag used within a block tag" %}
49+
::: example "Inline tag used within a block tag"
5050

5151
```js
5252
/**
@@ -59,11 +59,11 @@ Shoe.prototype.setColor = function(color) {
5959
// ...
6060
};
6161
```
62-
{% endexample %}
62+
:::
6363

6464
When you use multiple block tags in a JSDoc comment, they must be separated by line breaks:
6565

66-
{% example "Multiple block tags separated by line breaks" %}
66+
::: example "Multiple block tags separated by line breaks"
6767

6868
```js
6969
/**
@@ -76,4 +76,4 @@ Shoe.prototype.setLaceType = function(color, type) {
7676
// ...
7777
};
7878
```
79-
{% endexample %}
79+
:::

content/en/about-commandline.md renamed to content/about-commandline.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Command-line arguments to JSDoc
3-
description: About command-line arguments to JSDoc.
3+
tags: gettingStarted
44
related:
5-
- about-configuring-jsdoc.html
5+
- /about-configuring-jsdoc
66
---
77

88
At its most basic level, JSDoc is used like so:
@@ -43,30 +43,30 @@ Option|Description
4343
`-X`, `--explain`|Dump all doclets to the console in JSON format, then exit.
4444

4545

46-
[config-file]: about-configuring-jsdoc.html
47-
[including-readme]: about-including-readme.html
48-
[md-file]: http://daringfireball.net/projects/markdown/
49-
[private-tag]: tags-private.html
50-
[tutorials]: about-tutorials.html
46+
[config-file]: /about-configuring-jsdoc
47+
[including-readme]: /about-including-readme
48+
[md-file]: https://daringfireball.net/projects/markdown/
49+
[private-tag]: /tags-private
50+
[tutorials]: /about-tutorials
5151

5252

5353
## Examples
5454

5555
Generate documentation for files in the `./src` directory, using the configuration file
5656
`/path/to/my/conf.json`, and save the output in the `./docs` directory:
5757

58-
{% example %}
58+
::: example
5959

6060
```
6161
/path/to/jsdoc src -r -c /path/to/my/conf.json -d docs
6262
```
63-
{% endexample %}
63+
:::
6464

6565
Run all JSDoc tests whose names include the word `tag`, and log information about each test:
6666

67-
{% example %}
67+
::: example
6868

6969
```
7070
/path/to/jsdoc -T --match tag --verbose
7171
```
72-
{% endexample %}
72+
:::

content/en/about-configuring-default-template.md renamed to content/about-configuring-default-template.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Configuring JSDoc's default template
3-
description: How to configure the output from JSDoc's default template.
3+
tags: gettingStarted
44
related:
5-
- about-configuring-jsdoc.html
5+
- /about-configuring-jsdoc
66
---
77

88
JSDoc's default template provides several options that you can use to customize the appearance and
@@ -11,7 +11,7 @@ content of generated documentation.
1111
To use these options, you must [create a configuration file][about-config] for JSDoc and set the
1212
appropriate options in the configuration file.
1313

14-
[about-config]: about-configuring-jsdoc.html
14+
[about-config]: /about-configuring-jsdoc
1515

1616

1717
## Generating pretty-printed source files
@@ -42,7 +42,7 @@ copy. If this property is not defined, all files will be copied.
4242
+ `templates.default.staticFiles.excludePattern`: A regular expression indicating which files to
4343
skip. If this property is not defined, nothing will be skipped.
4444

45-
{% example "Copying a directory of images to the output directory" %}
45+
::: example "Copying a directory of images to the output directory"
4646

4747
To copy all of the static files in `./myproject/static` to the output directory:
4848

@@ -63,7 +63,7 @@ To copy all of the static files in `./myproject/static` to the output directory:
6363
If your static files directory contains the file `./myproject/static/img/screen.png`, you can
6464
display the image in your docs by using the HTML tag `<img src="img/screen.png">`.
6565

66-
{% endexample %}
66+
:::
6767

6868

6969
## Showing the current date in the page footer

0 commit comments

Comments
 (0)